Skip to content

Commit

Permalink
Merge pull request #491 from hkad98/release-docs
Browse files Browse the repository at this point in the history
TRIVIAL: document release process

Reviewed-by: Jan Soubusta
             https://github.com/jaceksan
  • Loading branch information
gdgate authored Dec 20, 2023
2 parents a7f6399 + a24219d commit e4bdcd9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 22 deletions.
27 changes: 14 additions & 13 deletions .github/workflows/bump-version.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,20 @@ jobs:
done
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# create-release-branch:
# needs:
# - bump-version
# runs-on: ubuntu-latest
# steps:
# - name: Checkout
# uses: actions/checkout@v3
# - name: Create documentation rel/${{ github.event.inputs.bump_type }} branch
# run: |
# git config user.name GitHub Actions
# git config user.email [email protected]
# git checkout -b rel/${{ needs.bump-version.outputs.new_version }}
# git push origin rel/${{ needs.bump-version.outputs.new_version }}
create-release-branch:
needs:
- bump-version
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Create documentation rel/${{ github.event.inputs.bump_type }} branch
run: |
git config user.name GitHub Actions
git config user.email [email protected]
git checkout -b rel/${{ needs.bump-version.outputs.new_version }}
git push origin rel/${{ needs.bump-version.outputs.new_version }}
# TODO: this part waits for docs build and publish optimization it takes too long (~15 minutes)
# trigger-release:
# needs:
# - bump-version
Expand Down
11 changes: 2 additions & 9 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,8 @@
# Repository maintenance and release

## How to release
* add new documentation version
* edit redirects in [./docs/layouts/index.redir](docs/layouts/index.redir)
* add the new version to the version picker in [./docs/config/production/params.toml](docs/config/production/params.toml)
* run `make release VERSION=X.Y.Z`
* create a pull request with the latest commit with bumped versions
* ask for merge of a pull request
* create a new branch named `rel/X.Y.Z` from master
* This branch now hosts the content for documentation of the X.Y.Z version. Any changes to the content in the branch will be public.
* dispatch the GitHub workflow `netlify-deploy` on the `master` branch
* manually run [Bump version & trigger release](.github/workflows/bump-version.yaml) workflow
* dispatch the GitHub workflow `netlify-deploy` on the `master` branch (takes ~15 minutes)
* The styling of the documentation is taken from the `master` branch. For more details see [./scripts/generate.sh](scripts/generate.sh) and [netlify-deploy](.github/workflows/netlify-deploy.yaml) workflow.
* checkout latest master branch and tag it `vX.Y.Z`
* push the tag to the gooddata/gooddata-python-sdk repository (e.g. `git push <remote> vX.Y.Z`)
Expand Down

0 comments on commit e4bdcd9

Please sign in to comment.