The Cartographer project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.
To make a new version of Cartographer available via this packaging mechanism, the following steps must be followed:
Update ./vendir.yaml to
point at the new release of Cartographer
.
├── ...
├── src
│ └── cartographer
│ └── config
│ ├── ...
│ └── upstream
│ ├── cartographer
│ │ └── cartographer.yaml """ vendir'ed file """
│ └── cartographer-conventions
│ └── cartographer-conventions-v0.1.0-build.1.yaml """ vendir'ed file """
├── tests
│ ├── ...
│ ├── 01-test-convention-setup
│ │ └── cartographer-conventions-samples-convention-server-v0.1.0-build.1.yaml """ vendir'ed file """
│ ├── ...
├── vendir.lock.yml
└── vendir.yml """ this file """In order to gather the latest updates from Cartographer, this repository makes use of vendir to fetch the desired contents from the cartographer repository.
Given that with vendir we must point at a specific version, we need to update
the file where that version is inserted to point at the latest one.
For instance, assuming a bump of Cartographer from 0.2.1 to 0.2.2, we'd
patch the tag:
+++ b/vendir.yml
@@ -20,6 +20,6 @@ directories:
- path: '.'
githubRelease:
disableAutoChecksumValidation: true
- tag: v0.2.1
+ tag: v0.2.2
assetNames: ["cartographer.yaml"]
slug: vmware-tanzu/cartographerRun vendir sync from the ./vendir.yml
With vendir.yml pointing at the right place, vendir sync takes care of
fetching the assets we want and then placing them in the right place
(./upstream).
Having the upstream directory up to date, create a new pull request with the changes.
GitHub actions will take care of packaging it all up and making sure (by running e2e tests) that everything is working as expected.
Once merged, tag the commit with the desired version (for instance, in
our example, v0.2.2) and push - GitHub actions will then take care of
creating a new draft release named after the tag (location:
https://github.com/vmware-tanzu/package-for-cartographer/releases).
With the draft release available, if everything is good to go, promote the draft release to a public release.
This is a rough outline of what a contributor's workflow looks like:
- Create a topic branch from where you want to base your work
- Make commits of logical units
- Make sure your commit messages are in the proper format (see below)
- Push your changes to a topic branch in your fork of the repository
- Submit a pull request
Example:
git remote add upstream https://github.com/vmware-tanzu/package-for-cartographer.git
git checkout -b my-new-feature main
git commit -a
git push origin my-new-featureWhen your branch gets out of sync with the vmware/main branch, use the following to update:
git checkout my-new-feature
git fetch -a
git pull --rebase upstream main
git push --force-with-lease origin my-new-featureIf your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into existing commits.
If your pull request contains a single commit or your changes are related to the most recent commit, you can simply amend the commit.
git add .
git commit --amend
git push --force-with-lease origin my-new-featureIf you need to squash changes into an earlier commit, you can use:
git add .
git commit --fixup <commit>
git rebase -i --autosquash main
git push --force-with-lease origin my-new-featureBe sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a notification when you git push.
We follow the conventions on How to Write a Git Commit Message.
Be sure to include any related GitHub issue references in the commit message. See GFM syntax for referencing issues and commits.
When opening a new issue, try to roughly follow the commit message format conventions above.