Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.38 KB

Contributing

Getting started

The tools for this repository can be installed using mise. Once your shell has been configured to activate mise, navigate to the repository, run mise trust to allow the installation of the tools listed in .mise.toml, and then mise install to install anything missing.

Changelog

Changelog management is done via changie. See the installation guide for changie.

Run changie new in the top level directory. Here is an example of what that looks like:

$ changie new
✔ Component … runtime
✔ Kind … Improvements
✔ Body … Cool new feature.
✔ GitHub Pull Request … 123

Release

To release a new version use changie to update the changelog file, open a PR for that change. Once that PR merges it will trigger a release workflow.

$ changie batch auto
$ changie merge
$ git add .
$ git commit -m "Changelog for $(changie latest)"

After the release, also bump the version in pulumi/pulumi. Do this by updating the version in the get-language-providers.sh script in the pulumi/pulumi repository.