Skip to content

Commit

Permalink
Document release process in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gma committed Nov 8, 2024
1 parent 9db0879 commit 3a32e4d
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,19 @@ Then run the tests:
```sh
devcontainer features test --skip-autogenerated .
```

If writing new tests, the [cli testing docs] are the best place to read up on how the test framework works.

[cli testing docs]: https://github.com/devcontainers/cli/blob/HEAD/docs/features/test.md

Releasing features
------------------

If you're ready to release a new version of a feature, you'll need to bump the version number in the `devcontainer-feature.json` file. Follow [semantic versioning] when choosing the version number.

Documentation for a feature (in a feature-specific `README.md` file) is auto-generated from the feature's metadata, and (if present) a `NOTES.md` file in the feature's directory. So write instructions for users in the `NOTES.md` file. The GitHub action will automatically produce a pull request that creates/updates the `README.md` file, as required.

To actually publish a feature you can use the `devcontainer features publish` command, but the easy way is to run the GitHub action. Head over to the [Actions tab], find the Release action, and run it.

[semantic versioning]: https://semver.org/
[Actions tab]: https://github.com/gma/devcontainer-features/actions

0 comments on commit 3a32e4d

Please sign in to comment.