Skip to content

Describe release procedure #17

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 3, 2025
Merged

Describe release procedure #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# os2borgerpc-core-scripts
A suite of widely used OS2Borgerpc scripts maintained by the OS2BorgerPC project.

# Releases

Regular GitHub releases are used. For detailed instructions, see the [GitHub documentation on creating a release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release).

When drafting a release, the "Generate release notes" feature, as mentioned in the guide, should be used to create the release notes.

## Details
- A release is a tagged (versioned) package containing all the scripts.
- Each script is versioned individually (see the respective `*.md` files for version numbers).
- Because each script is individually versioned, some scripts may remain unchanged between releases, even if the overall package is updated.