*: rename master branch to main
This commit is contained in:
parent
135675243a
commit
b8cca6cef1
|
|
@ -57,9 +57,9 @@ codestyle: {
|
||||||
buildPod(runAsUser:0) {
|
buildPod(runAsUser:0) {
|
||||||
checkout scm
|
checkout scm
|
||||||
shwrap("""
|
shwrap("""
|
||||||
# Jenkins by default only fetches the branch it's testing. Explicitly fetch master
|
# Jenkins by default only fetches the branch it's testing. Explicitly fetch main
|
||||||
# for ci-commitmessage-submodules.sh
|
# for ci-commitmessage-submodules.sh
|
||||||
git fetch origin +refs/heads/master:refs/remotes/origin/master
|
git fetch origin +refs/heads/main:refs/remotes/origin/main
|
||||||
ci/ci-commitmessage-submodules.sh
|
ci/ci-commitmessage-submodules.sh
|
||||||
""")
|
""")
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,7 @@ This guide requires:
|
||||||
- Prepare local environment:
|
- Prepare local environment:
|
||||||
- [ ] `git remote get-url --push origin`
|
- [ ] `git remote get-url --push origin`
|
||||||
- [ ] validate that the output above points to `git@github.com:ostreedev/ostree.git`
|
- [ ] validate that the output above points to `git@github.com:ostreedev/ostree.git`
|
||||||
- [ ] `git checkout master && git pull`
|
- [ ] `git checkout main && git pull`
|
||||||
- [ ] `git clean -fd`
|
- [ ] `git clean -fd`
|
||||||
- [ ] `RELEASE_VER=yyyy.n` (matching `package_version` in `configure.ac`)
|
- [ ] `RELEASE_VER=yyyy.n` (matching `package_version` in `configure.ac`)
|
||||||
- [ ] `git checkout -b release-${RELEASE_VER}`
|
- [ ] `git checkout -b release-${RELEASE_VER}`
|
||||||
|
|
@ -56,7 +56,7 @@ This guide requires:
|
||||||
|
|
||||||
- Clean up:
|
- Clean up:
|
||||||
- [ ] `git clean -fd`
|
- [ ] `git clean -fd`
|
||||||
- [ ] `git checkout master`
|
- [ ] `git checkout main`
|
||||||
- [ ] `git pull`
|
- [ ] `git pull`
|
||||||
- [ ] `git push origin :release-${RELEASE_VER}`
|
- [ ] `git push origin :release-${RELEASE_VER}`
|
||||||
- [ ] `git branch -d release-${RELEASE_VER}`
|
- [ ] `git branch -d release-${RELEASE_VER}`
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ name: Release
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [master]
|
branches: [main]
|
||||||
paths:
|
paths:
|
||||||
- 'configure.ac'
|
- 'configure.ac'
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
name: Rust
|
name: Rust
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [master]
|
branches: [main]
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [master]
|
branches: [main]
|
||||||
|
|
||||||
env:
|
env:
|
||||||
CARGO_TERM_COLOR: always
|
CARGO_TERM_COLOR: always
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@ jobs:
|
||||||
- job: production_build
|
- job: production_build
|
||||||
trigger: commit
|
trigger: commit
|
||||||
metadata:
|
metadata:
|
||||||
branch: master
|
branch: main
|
||||||
targets: f34-coreos-continuous
|
targets: f34-coreos-continuous
|
||||||
specfile_path: ostree.spec
|
specfile_path: ostree.spec
|
||||||
actions:
|
actions:
|
||||||
|
|
|
||||||
|
|
@ -130,7 +130,7 @@ However, in order to build from a git clone, you must update the
|
||||||
submodules. If you're packaging OSTree and want a tarball, I
|
submodules. If you're packaging OSTree and want a tarball, I
|
||||||
recommend using a "recursive git archive" script. There are several
|
recommend using a "recursive git archive" script. There are several
|
||||||
available online;
|
available online;
|
||||||
[this code](https://github.com/ostreedev/ostree/blob/master/packaging/Makefile.dist-packaging#L11)
|
[this code](https://github.com/ostreedev/ostree/blob/main/packaging/Makefile.dist-packaging#L11)
|
||||||
in OSTree is an example.
|
in OSTree is an example.
|
||||||
|
|
||||||
Once you have a git clone or recursive archive, building is the
|
Once you have a git clone or recursive archive, building is the
|
||||||
|
|
@ -157,7 +157,7 @@ See [Contributing](CONTRIBUTING.md).
|
||||||
## Licensing
|
## Licensing
|
||||||
|
|
||||||
The licensing for the *code* of libostree can be canonically found in the individual files;
|
The licensing for the *code* of libostree can be canonically found in the individual files;
|
||||||
and the overall status in the [COPYING](https://github.com/ostreedev/ostree/blob/master/COPYING)
|
and the overall status in the [COPYING](https://github.com/ostreedev/ostree/blob/main/COPYING)
|
||||||
file in the source. Currently, that's LGPLv2+. This also covers the man pages and API docs.
|
file in the source. Currently, that's LGPLv2+. This also covers the man pages and API docs.
|
||||||
|
|
||||||
The license for the manual documentation in the `doc/` directory is:
|
The license for the manual documentation in the `doc/` directory is:
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,7 @@ gitdir=$(realpath $(pwd))
|
||||||
# require a newer git, we could use `git worktree`.
|
# require a newer git, we could use `git worktree`.
|
||||||
cp -a ${gitdir} ${tmpd}/workdir
|
cp -a ${gitdir} ${tmpd}/workdir
|
||||||
cd ${tmpd}/workdir
|
cd ${tmpd}/workdir
|
||||||
git log --pretty=oneline origin/master..$HEAD | while read logline; do
|
git log --pretty=oneline origin/main..$HEAD | while read logline; do
|
||||||
commit=$(echo ${logline} | cut -f 1 -d ' ')
|
commit=$(echo ${logline} | cut -f 1 -d ' ')
|
||||||
# For merge commits, just check that they're empty (i.e. no conflict
|
# For merge commits, just check that they're empty (i.e. no conflict
|
||||||
# resolution was needed). Otherwise, let's just error out. Conflicts should
|
# resolution was needed). Otherwise, let's just error out. Conflicts should
|
||||||
|
|
|
||||||
|
|
@ -72,7 +72,7 @@ For more information see [How to Write a Git Commit Message](https://chris.beams
|
||||||
|
|
||||||
**Editing a Committed Message:**
|
**Editing a Committed Message:**
|
||||||
|
|
||||||
To edit the message from the most recent commit run `git commit --amend`. To change older commits on the branch use `git rebase -i`. For a successful rebase have the branch track `upstream master`. Once the changes have been made and saved, run `git push --force origin <branch-name>`.
|
To edit the message from the most recent commit run `git commit --amend`. To change older commits on the branch use `git rebase -i`. For a successful rebase have the branch track `upstream main`. Once the changes have been made and saved, run `git push --force origin <branch-name>`.
|
||||||
|
|
||||||
## Running the test suite
|
## Running the test suite
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,7 @@ last_edit_time_format: "%b %e %Y at %I:%M %p"
|
||||||
gh_edit_link: true
|
gh_edit_link: true
|
||||||
gh_edit_link_text: "Edit this page on GitHub"
|
gh_edit_link_text: "Edit this page on GitHub"
|
||||||
gh_edit_repository: "https://github.com/ostreedev/ostree"
|
gh_edit_repository: "https://github.com/ostreedev/ostree"
|
||||||
gh_edit_branch: "master"
|
gh_edit_branch: "main"
|
||||||
gh_edit_source: docs
|
gh_edit_source: docs
|
||||||
gh_edit_view_mode: "tree"
|
gh_edit_view_mode: "tree"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -92,7 +92,7 @@ After these steps, systemd switches root.
|
||||||
If you are not using dracut or systemd, using OSTree should still be
|
If you are not using dracut or systemd, using OSTree should still be
|
||||||
possible, but you will have to write the integration code. See the
|
possible, but you will have to write the integration code. See the
|
||||||
existing sources in
|
existing sources in
|
||||||
[src/switchroot](https://github.com/ostreedev/ostree/tree/master/src/switchroot)
|
[src/switchroot](https://github.com/ostreedev/ostree/tree/main/src/switchroot)
|
||||||
as a reference.
|
as a reference.
|
||||||
|
|
||||||
Patches to support other initramfs technologies and init systems, if
|
Patches to support other initramfs technologies and init systems, if
|
||||||
|
|
|
||||||
|
|
@ -17,14 +17,14 @@ Fork https://github.com/ostreedev/ostree, then run the following commands.
|
||||||
```bash
|
```bash
|
||||||
$ git clone https://github.com/<username>/ostree && cd ostree
|
$ git clone https://github.com/<username>/ostree && cd ostree
|
||||||
$ git remote add upstream https://github.com/ostreedev/ostree
|
$ git remote add upstream https://github.com/ostreedev/ostree
|
||||||
$ git checkout master
|
$ git checkout main
|
||||||
$ git fetch upstream && git branch --set-upstream-to=upstream/master master
|
$ git fetch upstream && git branch --set-upstream-to=upstream/main main
|
||||||
```
|
```
|
||||||
Make a branch from master for your patch.
|
Make a branch from main for your patch.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git checkout -b <name-of-branch>
|
$ git checkout -b <name-of-branch>
|
||||||
$ git branch --set-upstream-to=upstream/master <name-of-branch>
|
$ git branch --set-upstream-to=upstream/main <name-of-branch>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building OSTree
|
## Building OSTree
|
||||||
|
|
@ -55,7 +55,7 @@ apt-get install build-essential && \
|
||||||
apt-get build-dep ostree
|
apt-get build-dep ostree
|
||||||
```
|
```
|
||||||
|
|
||||||
[build.sh](https://github.com/ostreedev/ostree/blob/master/ci/build.sh) will have a list of packages needed to build ostree.
|
[build.sh](https://github.com/ostreedev/ostree/blob/main/ci/build.sh) will have a list of packages needed to build ostree.
|
||||||
|
|
||||||
### OSTree Build Commands
|
### OSTree Build Commands
|
||||||
|
|
||||||
|
|
@ -120,7 +120,7 @@ RUN dnf update -y && \
|
||||||
dnf -y builddep ostree && \
|
dnf -y builddep ostree && \
|
||||||
dnf clean all
|
dnf clean all
|
||||||
|
|
||||||
# clone ostree and update master branch
|
# clone ostree and update main branch
|
||||||
COPY ostree-git.sh /
|
COPY ostree-git.sh /
|
||||||
RUN ../ostree-git.sh
|
RUN ../ostree-git.sh
|
||||||
|
|
||||||
|
|
@ -142,7 +142,7 @@ Save the following bash scripts in the same directory as the Dockerfile. Then ch
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
# ostree-git.sh
|
# ostree-git.sh
|
||||||
# Clone ostree and update master branch
|
# Clone ostree and update main branch
|
||||||
|
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
|
|
@ -153,10 +153,10 @@ USERNAME=""
|
||||||
git clone https://github.com/$USERNAME/ostree.git
|
git clone https://github.com/$USERNAME/ostree.git
|
||||||
cd ostree
|
cd ostree
|
||||||
|
|
||||||
# Add upstream as remote and update master branch
|
# Add upstream as remote and update main branch
|
||||||
git checkout master
|
git checkout main
|
||||||
git remote add upstream https://github.com/ostreedev/ostree.git
|
git remote add upstream https://github.com/ostreedev/ostree.git
|
||||||
git pull --rebase upstream master
|
git pull --rebase upstream main
|
||||||
```
|
```
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -407,13 +407,13 @@ Tests for OSTree are done by shell scripting, by running OSTree commands and exa
|
||||||
|
|
||||||
After you have committed your changes and tested, you are ready to submit your patch!
|
After you have committed your changes and tested, you are ready to submit your patch!
|
||||||
|
|
||||||
You should make sure your commits are placed on top of the latest changes from `upstream/master`:
|
You should make sure your commits are placed on top of the latest changes from `upstream/main`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git pull --rebase upstream master
|
$ git pull --rebase upstream main
|
||||||
```
|
```
|
||||||
|
|
||||||
To submit your patch, open a pull request from your forked repository. Most often, you'll be merging into `ostree:master` from `<username>:<branch name>`.
|
To submit your patch, open a pull request from your forked repository. Most often, you'll be merging into `ostree:main` from `<username>:<branch name>`.
|
||||||
|
|
||||||
If some of your changes are complete and you would like feedback, you may also open a pull request that has WIP (Work In Progress) in the title.
|
If some of your changes are complete and you would like feedback, you may also open a pull request that has WIP (Work In Progress) in the title.
|
||||||
|
|
||||||
|
|
@ -423,13 +423,13 @@ See [CONTRIBUTING.md](CONTRIBUTING.md#submitting-patches) for information on squ
|
||||||
|
|
||||||
### Returning Workflow
|
### Returning Workflow
|
||||||
|
|
||||||
When returning to work on a patch, it is recommended to update your fork with the latest changes in the upstream master branch.
|
When returning to work on a patch, it is recommended to update your fork with the latest changes in the upstream main branch.
|
||||||
|
|
||||||
If creating a new branch:
|
If creating a new branch:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git checkout master
|
$ git checkout main
|
||||||
$ git pull upstream master
|
$ git pull upstream main
|
||||||
$ git checkout -b <name-of-patch>
|
$ git checkout -b <name-of-patch>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -437,5 +437,5 @@ If continuing on a branch already created:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git checkout <name-of-patch>
|
$ git checkout <name-of-patch>
|
||||||
$ git pull --rebase upstream master
|
$ git pull --rebase upstream main
|
||||||
```
|
```
|
||||||
|
|
|
||||||
|
|
@ -127,7 +127,7 @@ However, in order to build from a git clone, you must update the
|
||||||
submodules. If you're packaging OSTree and want a tarball, I
|
submodules. If you're packaging OSTree and want a tarball, I
|
||||||
recommend using a "recursive git archive" script. There are several
|
recommend using a "recursive git archive" script. There are several
|
||||||
available online;
|
available online;
|
||||||
[this code](https://github.com/ostreedev/ostree/blob/master/packaging/Makefile.dist-packaging#L11)
|
[this code](https://github.com/ostreedev/ostree/blob/main/packaging/Makefile.dist-packaging#L11)
|
||||||
in OSTree is an example.
|
in OSTree is an example.
|
||||||
|
|
||||||
Once you have a git clone or recursive archive, building is the
|
Once you have a git clone or recursive archive, building is the
|
||||||
|
|
@ -148,7 +148,7 @@ See [Contributing](docs/CONTRIBUTING.md).
|
||||||
## Licensing
|
## Licensing
|
||||||
|
|
||||||
The licensing for the *code* of libostree can be canonically found in the individual files;
|
The licensing for the *code* of libostree can be canonically found in the individual files;
|
||||||
and the overall status in the [COPYING](https://github.com/ostreedev/ostree/blob/master/COPYING)
|
and the overall status in the [COPYING](https://github.com/ostreedev/ostree/blob/main/COPYING)
|
||||||
file in the source. Currently, that's LGPLv2+. This also covers the man pages and API docs.
|
file in the source. Currently, that's LGPLv2+. This also covers the man pages and API docs.
|
||||||
|
|
||||||
The license for the manual documentation in the `doc/` directory is:
|
The license for the manual documentation in the `doc/` directory is:
|
||||||
|
|
|
||||||
|
|
@ -121,7 +121,7 @@ Like git, OSTree uses the terminology "references" (abbreviated
|
||||||
commits. See the
|
commits. See the
|
||||||
[Git Documentation](https://git-scm.com/book/en/v2/Git-Internals-Git-References)
|
[Git Documentation](https://git-scm.com/book/en/v2/Git-Internals-Git-References)
|
||||||
for information on how git uses them. Unlike git though, it doesn't
|
for information on how git uses them. Unlike git though, it doesn't
|
||||||
usually make sense to have a "master" branch. There is a convention
|
usually make sense to have a "main" branch. There is a convention
|
||||||
for references in OSTree that looks like this:
|
for references in OSTree that looks like this:
|
||||||
`exampleos/buildmaster/x86_64-runtime` and
|
`exampleos/buildmaster/x86_64-runtime` and
|
||||||
`exampleos/buildmaster/x86_64-devel-debug`. These two refs point to
|
`exampleos/buildmaster/x86_64-devel-debug`. These two refs point to
|
||||||
|
|
|
||||||
|
|
@ -117,7 +117,7 @@ log links to build logs, etc.), but we're reusing the *content* from the `buildm
|
||||||
commit `aec070645fe53` that passed the smoketests.
|
commit `aec070645fe53` that passed the smoketests.
|
||||||
|
|
||||||
For a more sophisticated implementation of this model, see the
|
For a more sophisticated implementation of this model, see the
|
||||||
[do-release-tags](https://github.com/ostreedev/ostree-releng-scripts/blob/master/do-release-tags)
|
[do-release-tags](https://github.com/ostreedev/ostree-releng-scripts/blob/main/do-release-tags)
|
||||||
script, which includes support for things like propagating version
|
script, which includes support for things like propagating version
|
||||||
numbers across commit promotion.
|
numbers across commit promotion.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue