diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml new file mode 100644 index 0000000..7eb2adf --- /dev/null +++ b/.github/workflows/release-please.yml @@ -0,0 +1,20 @@ +name: Release Please + +on: + push: + branches: + - master + +permissions: + contents: write + pull-requests: write + +jobs: + release-please: + runs-on: ubuntu-latest + steps: + - uses: googleapis/release-please-action@v4 + with: + # This should be a GitHub secret containing a PAT with repo scope + # Falls back to GITHUB_TOKEN if not set + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 0000000..466df71 --- /dev/null +++ b/.release-please-manifest.json @@ -0,0 +1,3 @@ +{ + ".": "0.1.0" +} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1720359 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +## 0.1.0 + +### Features + +* Use GitHub Actions instead of CircleCI for CI diff --git a/README.md b/README.md index 7e3d0c3..a562c9b 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,22 @@ each internal node. Canonicalization of normal directed and undirected graphs can also be reduced to ELDAG canonicalized. Actual direct support of plain graph canonicalization is to be implemented. +## Releases + +This project uses +[release-please](https://github.com/googleapis/release-please) for automated +release management. Releases are automatically created when changes are merged +to the master branch following [Conventional +Commits](https://www.conventionalcommits.org/) format. The CHANGELOG is +automatically maintained based on commit messages. + +## Acknowledgments + +Libcanon was developed by Jinmo Zhao at Rice University, under the supervision +of Prof. Gustavo E. Scuseria, as a component of the symbolic tensorial algebra +system [drudge](https://github.com/DrudgeCAS/drudge). It was supported as part +of the Center for the Computational Design of Functional Layered Materials, an +Energy Frontier Research Center funded by the U.S. Department of Energy, +Office of Science, Basic Energy Sciences under Award DE-SC0012575. The package +is currently maintained by Guo P. Chen and other members of the Scuseria group. -Libcanon is developed by Jinmo Zhao and Prof Gustavo E Scuseria at Rice -University to be used in the symbolic tensorial algebra system -[drudge](https://github.com/tschijnmo/drudge). It was supported as part of the -Center for the Computational Design of Functional Layered Materials, an Energy -Frontier Research Center funded by the U.S. Department of Energy, Office of -Science, Basic Energy Sciences under Award DE-SC0012575. diff --git a/release-please-config.json b/release-please-config.json new file mode 100644 index 0000000..79fe1f5 --- /dev/null +++ b/release-please-config.json @@ -0,0 +1,16 @@ +{ + "packages": { + ".": { + "release-type": "simple", + "package-name": "libcanon", + "changelog-path": "CHANGELOG.md", + "extra-files": [ + { + "type": "generic", + "path": "CMakeLists.txt", + "glob": false + } + ] + } + } +}