Skip to content

Commit b32dd01

Browse files
authored
Merge pull request #1 from pohly/master
initial content
2 parents d23a16c + c876547 commit b32dd01

File tree

3 files changed

+109
-1218
lines changed

3 files changed

+109
-1218
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [csi-build-rules](https://github.com/kubernetes-csi/csi-build-rules)
1+
# [csi-release-tools](https://github.com/kubernetes-csi/csi-release-tools)
22

33
These build and test rules can be shared between different Go projects
44
without modifications. Customization for the different projects happen
@@ -19,9 +19,9 @@ The expected repository layout is:
1919
- `cmd/*/*.go` - source code for each command
2020
- `cmd/*/Dockerfile` - docker file for each command or
2121
Dockerfile in the root when only building a single command
22-
- `Makefile` - includes `build-rules/build.make` and sets
22+
- `Makefile` - includes `release-tools/build.make` and sets
2323
configuration variables
24-
- `.travis.yml` - a symlink to `build-rules/.travis.yml`
24+
- `.travis.yml` - a symlink to `release-tools/.travis.yml`
2525

2626
To create a release, tag a certain revision with a name that
2727
starts with `v`, for example `v1.0.0`, then `make push`
@@ -40,11 +40,12 @@ Sharing and updating
4040

4141
[`git subtree`](https://github.com/git/git/blob/master/contrib/subtree/git-subtree.txt)
4242
is the recommended way of maintaining a copy of the rules inside the
43-
`build-rules` directory of a project. This way, it is possible to make
43+
`release-tools` directory of a project. This way, it is possible to make
4444
changes also locally, test them and then push them back to the shared
4545
repository at a later time.
4646

4747
Cheat sheet:
4848

49-
- `git subtree pull --prefix=build-rules https://github.com/kubernetes-csi/csi-build-rules.git master` - update local copy to latest upstream
50-
- edit, `git commit`, `git subtree push --prefix=build-rules [email protected]:<user>/csi-build-rules.git <my-new-or-existing-branch>` - push to a new branch before submitting a PR
49+
- `git subtree add --prefix=release-tools https://github.com/pohly/csi-release-tools.git master` - add release tools to a repo which does not have them yet (only once)
50+
- `git subtree pull --prefix=release-tools https://github.com/kubernetes-csi/csi-release-tools.git master` - update local copy to latest upstream (whenever upstream changes)
51+
- edit, `git commit`, `git subtree push --prefix=release-tools [email protected]:<user>/csi-release-tools.git <my-new-or-existing-branch>` - push to a new branch before submitting a PR

RELEASE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Release Process
22

3-
TODO: describe the release process for this project
3+
No tagged releases are planned at this point. The intention is to keep
4+
the master branch in a state such that it can be used for all
5+
supported branches in downstream repos which use these files.

0 commit comments

Comments
 (0)