Skip to content

Commit

Permalink
Add documentation regarding release process
Browse files Browse the repository at this point in the history
Summary: Add some instructions regarding release to the CONTRIBUTING.md file. Also added some updates to the changelog

Reviewed By: talgalili

Differential Revision: D42609020

fbshipit-source-id: a8f7a9b8c5fdf097146444c2308ab518d97fe874
  • Loading branch information
Steve Mandala authored and facebook-github-bot committed Jan 19, 2023
1 parent 448fb3f commit 66ccbbd
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@
- logo
- with contributors
- typo fixes (props to @zbraiterman and @luca-martial).
- Added section about "Releasing a new version" to CONTRIBUTING.md
- Available under ["Docs/Contributing"](https://import-balance.org/docs/docs/contributing/#releasing-a-new-version) section of website


## Misc
- Added automated Github Action package builds & deployment to PyPi on release.
- See [release.yml](https://github.com/facebookresearch/balance/blob/main/.github/workflows/release.yml)

0.1.0 (2022-11-20)
==================
Expand Down
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,15 @@ In summary
* We also run the same "Build & Test" suite nightly.
* On every push, we deploy a new version of the website. The `make_docs.sh` script is run from the main branch and the build artifacts are published to the `gh-pages` branch, which is linked to our repo's Github Page's deployment.

### Releasing a new version
To create a new release, simply navigate to the ["Release" page](https://github.com/facebookresearch/balance/releases) of the repo, draft a new release, and publish. The Github Action workflow should be triggered on publish and you should see a new version of the package live on PyPi in ~10 mins. You can check the status of the job via the [GH Actions tab](https://github.com/facebookresearch/balance/actions).

Guidelines when drafting a new release:
* Follow semantic versioning conventions when chosing the next version.
* The release's tag should only be the version itself (e.g. "0.1.0"). Do not add any prefixes like "v" or "version". The build process relies on proper formatting of this tag.

The Github Actions job is configured at [release.yml](https://github.com/facebookresearch/balance/blob/main/.github/workflows/release.yml).

## License
By contributing to balance, you agree that your contributions will be licensed
under the LICENSE file in the root directory of this source tree.

0 comments on commit 66ccbbd

Please sign in to comment.