Prep work for branch renaming (#389)

* Add `amd-staging` and `amd-mainline` to workflow.
* Update branch names in documentation
* Change `dev` to `amd-staging` and `main` to `amd-mainline` in documentation.
* Remove references from 2.x from workflows.
* Convert the link to LICENSE to a relative path in CONTRIBUTING.

---------

Signed-off-by: David Galiffi <David.Galiffi@amd.com>
This commit is contained in:
David Galiffi
2024-08-02 16:33:41 -04:00
parent 5cd25714e6
commit e176d8eec8
9 changed files with 23 additions and 26 deletions
+2 -2
View File
@@ -2,7 +2,7 @@ name: Documentation
on:
push:
branches: ["main"]
branches: [ main, amd-mainline ]
paths:
- 'docs/archive/docs-2.x/**'
- 'docs/archive/docs-1.x/**'
@@ -36,7 +36,7 @@ jobs:
- name: Build 1.x docs
run: |
cd docs/archive/docs-1.x
make html
make html
- name: Build 2.x docs
run: |
cd docs/archive/docs-2.x
+2 -2
View File
@@ -3,9 +3,9 @@ name: Formatting
on:
push:
branches: [ main, dev, 2.x ]
branches: [ main, dev, amd-mainline, amd-staging ]
pull_request:
branches: [ main, dev, 2.x ]
branches: [ main, dev, amd-mainline, amd-staging ]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
+2 -3
View File
@@ -2,11 +2,10 @@ name: mi-rhel9
on:
push:
branches:
- 'main'
branches: [ main, amd-mainline ]
# Allows manual execution
workflow_dispatch:
workflow_dispatch:
permissions:
contents: read
+1 -1
View File
@@ -8,7 +8,7 @@ on:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
distbuild:
runs-on: ubuntu-latest
+2 -2
View File
@@ -5,9 +5,9 @@ name: RHEL 8
# Controls when the workflow will run
on:
push:
branches: [ main, dev ]
branches: [ main, dev, amd-mainline, amd-staging ]
pull_request:
branches: [ main, dev ]
branches: [ main, dev, amd-mainline, amd-staging ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
+5 -7
View File
@@ -2,15 +2,13 @@ name: tarball
on:
push:
branches:
- main
- 2.x
branches: [ main, amd-mainline ]
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
distbuild:
runs-on: ubuntu-latest
@@ -25,7 +23,7 @@ jobs:
echo "sha=${{github.event.pull_request.head.sha}}" >> $GITHUB_OUTPUT
else
echo "sha=$GITHUB_SHA" >> $GITHUB_OUTPUT
fi
fi
- name: Checkout code
uses: actions/checkout@v4
with:
@@ -101,9 +99,9 @@ jobs:
run: sudo apt-get install -y lmod
- name: Access omniperf using modulefile
run: |
. /etc/profile.d/lmod.sh
. /etc/profile.d/lmod.sh
module use $INSTALL_DIR/omniperf/share/omniperf/modulefiles
module load omniperf
module list
omniperf --version
+2 -2
View File
@@ -4,9 +4,9 @@ name: Ubuntu 22.04
on:
push:
branches: [ main, dev ]
branches: [ main, dev, amd-mainline, amd-staging ]
pull_request:
branches: [ main, dev ]
branches: [ main, dev, amd-mainline, amd-staging ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
+4 -4
View File
@@ -1,12 +1,12 @@
## How to fork from us
To keep our development fast and conflict free, we recommend you to [fork](https://github.com/ROCm/omniperf/fork) our repository and start your work from our `dev` branch in your private repository.
To keep our development fast and conflict free, we recommend you to [fork](https://github.com/ROCm/omniperf/fork) our repository and start your work from our `amd-staging` branch in your private repository.
Afterwards, git clone your repository to your local machine. But that is not it! To keep track of the original develop repository, add it as another remote.
```
git remote add mainline https://github.com/ROCm/omniperf.git
git checkout dev
git checkout amd-staging
```
As always in git, start a new branch with
@@ -31,9 +31,9 @@ and apply your changes there.
- Ensure the PR description clearly describes the problem and solution. If there is an existing GitHub issue open describing this bug, please include it in the description so we can close it.
- Ensure the PR is based on the `dev` branch of the Omniperf GitHub repository.
- Ensure the PR is based on the `amd-staging` branch of the Omniperf GitHub repository.
- Omniperf requires new commits to include a "Signed-off-by" token in the commit message (typically enabled via the `git commit -s` option), indicating your agreement to the projects's [Developer's Certificate of Origin](https://developercertificate.org/) and compatability with the project [LICENSE](https://github.com/ROCm/omniperf/blob/main/LICENSE):
- Omniperf requires new commits to include a "Signed-off-by" token in the commit message (typically enabled via the `git commit -s` option), indicating your agreement to the projects's [Developer's Certificate of Origin](https://developercertificate.org/) and compatability with the project [LICENSE](LICENSE):
> (a) The contribution was created in whole or in part by me and I
+3 -3
View File
@@ -29,10 +29,10 @@ contribution process.
Omniperf follows a
[main-dev](https://nvie.com/posts/a-successful-git-branching-model/)
branching model. As a result, our latest stable release is shipped
from the `main` branch, while new features are developed in our
`dev` branch.
from the `amd-mainline` branch, while new features are developed in our
`amd-staging` branch.
Users may checkout `dev` to preview upcoming features.
Users may checkout `amd-staging` to preview upcoming features.
## How to Cite