Skip to content

Commit

Permalink
Prep work for branch renaming (#389)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
dgaliffiAMD authored Aug 2, 2024
1 parent e6747da commit 780f55e
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 26 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/**'
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/formatting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/mi-rhel9.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/packaging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
distbuild:
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/rhel-8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 5 additions & 7 deletions .github/workflows/tarball.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions .github/workflows/ubuntu-jammy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 780f55e

Please sign in to comment.