Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release automation and documentation #77

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/release-updates.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Automatically updates "vX" branches based on GitHub releases. To cut a new
# release, use the GitHub UI where you enter a tag name and release name of
# "vX.Y.Z". See https://github.com/jupyterhub/repo2docker-action/releases.
---
name: Release updates

on:
release:
types: [published, edited]

jobs:
actions-tagger:
runs-on: windows-latest
permissions:
contents: write
steps:
# Action reference: https://github.com/Actions-R-Us/actions-tagger
- uses: Actions-R-Us/actions-tagger@f411bd910a5ad370d4511517e3eac7ff887c90ea
with:
# By using branches as identifiers it is still possible to backtrack
# some patch, but not if we use tags.
prefer_branch_releases: true
token: "${{ github.token }}"
10 changes: 10 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Making a release

Releases are automated through
[.github/workflows/release-updates.yaml](https://github.com/jupyterhub/repo2docker-action/blob/HEAD/.github/workflows/release-updates.yaml).

To cut a release, visit the projects [releases
page](https://github.com/jupyterhub/repo2docker-action/releases) where
you create a new GitHub release. Enter a _tag name_ and _release name_ of
"vX.Y.Z". Doing so will automatically update the "vX" branch allowing users to
reference this action with `jupyterhub/repo2docker-action@vX`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make a note that you have to change the docs and examples to point to the new version?

Copy link
Member Author

@consideRatio consideRatio Jul 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 90f2162!