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.

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

Jump to bottom

Update README to include Updating Configurations #5

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update README to include Updating Configurations #5

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be15f50
README.md: Added section on 'Updating a Configurations Version
CodeGat Sep 6, 2024
e69194c
Apply suggestions from code review
CodeGat Sep 27, 2024
0da7982
Using git describe tags
CodeGat Sep 27, 2024
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
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,24 @@ This means that `*-1.0` and `*-1.1` are configurations for that particular exper

Similarly, `*-3.0` is not reproducible with `*-1.0`, `*-1.1` or `*-2.0`.

### Updating a Configurations Version

To update a configuration that you're using, you can do the following:

```bash
git fetch --tags # Make sure your repository has all of them!
git describe --tags # Get the current tag
git tag --list release-CONFIG-* # List all available tags for CONFIG
CodeGat marked this conversation as resolved.
Show resolved Hide resolved
```

aidanheerdegen marked this conversation as resolved.
Show resolved Hide resolved
You can then pick out a config tag that you want to upgrade like so:

```bash
git merge release-CONFIG-VERSION
```

[Resolve any conflicts](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line?platform=linux), add the modified files and then `git commit` with an informative commit message about the version update.

aidanheerdegen marked this conversation as resolved.
Show resolved Hide resolved
### Checks

These checks are in the context of:
Expand Down