From f24bc0a9e0f3a5b8840f747bcea2f6bb662c3bcd Mon Sep 17 00:00:00 2001 From: Matthew Seaman Date: Fri, 13 Oct 2023 11:34:37 +0100 Subject: [PATCH] Update README.md (#1) * Update README.md * We don't want to use the netbox-community pull-request template * Update container building workflow * Only build amd64 images * Add our 'oxcert' branch as equivalent to upstream's 'release' branch * Tag the version of the container as OxCERT's modification This is just for the netbox container: the underlying netbox version will come from upstream * Build own own images and push to ghcr.io * Only build amd64 images * Only push images to GitHub Container Registry for the OxCERT organization * Refer to our private copy in the GitHub Container Registry ghcr.io * Use ghcr.io/oxcert/netbox for all netbox images Build and push to this repo. Read from it with docker-compose * Make releases relative to the 'oxcert' branch rather than upstream's 'release' branch. This is a different workflow than used in any of our other repos, where PRs, changes, etc. are first merged into a 'develop' branch, and the release process is to merge accumulated changes into the main 'oxcert' branch. Tag names for releases should follow whatever upstream is using with "-oxcert" appended. * Re-add the pull-request template But in a very cut-down form. We don't have an issue tracker on this repo, and we assume the intentions and motivations for any PR will have been discussed within the team already. We do, however, want all PRs to be against the 'develop' branch, in parallel to upstream's workflow. * On second thoughts, set container version to 1.0.0 This is OxCERT's version 1.0.0 of the containerized Netbox image which is basically the same as the 2.7.0 netbox-community equivalent. * Fix typo from upstream Function should have been called `git_rebase()` rather than duplicating the name of `git_merge()` --- .github/pull_request_template.md | 63 -------------------------------- .github/workflows/push.yml | 5 ++- .github/workflows/release.yml | 22 +---------- README.md | 6 +++ VERSION | 2 +- build.sh | 4 +- docker-compose.yml | 2 +- release.sh | 14 +++---- 8 files changed, 22 insertions(+), 96 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 139ff96..ed0a297 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,68 +12,6 @@ on all relevant titles. ######################################################################### --> - - -Related Issue: - -## New Behavior - - - -... - -## Contrast to Current Behavior - - - -... - -## Discussion: Benefits and Drawbacks - - - -... - -## Changes to the Wiki - - - -... - -## Proposed Release Note Entry - - - -... - ## Double Check * [ ] I have read the comments and followed the PR template. -* [ ] I have explained my PR according to the information in the comments. * [ ] My PR targets the `develop` branch. diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml index e7766db..177f1bc 100644 --- a/.github/workflows/push.yml +++ b/.github/workflows/push.yml @@ -5,9 +5,11 @@ on: push: branches-ignore: - release + - oxcert pull_request: branches-ignore: - release + - oxcert jobs: lint: @@ -51,12 +53,11 @@ jobs: - ./build.sh develop platform: - linux/amd64 - - linux/arm64 fail-fast: false env: GH_ACTION: enable GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - IMAGE_NAMES: docker.io/netboxcommunity/netbox + IMAGE_NAMES: ghcr.io/oxcert/netbox runs-on: ubuntu-latest name: Builds new NetBox Docker Images steps: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1dd2c3a..6ee202e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,14 +19,14 @@ jobs: - ./build.sh feature - ./build.sh develop platform: - - linux/amd64,linux/arm64 + - linux/amd64 fail-fast: false runs-on: ubuntu-latest name: Builds new NetBox Docker Images env: GH_ACTION: enable GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - IMAGE_NAMES: docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox ghcr.io/netbox-community/netbox + IMAGE_NAMES: ghcr.io/oxcert/netbox steps: - id: source-checkout name: Checkout @@ -48,24 +48,6 @@ jobs: name: Test the image run: IMAGE="${FINAL_DOCKER_TAG}" ./test.sh if: steps.docker-build.outputs.skipped != 'true' - # docker.io - - id: docker-io-login - name: Login to docker.io - uses: docker/login-action@v2 - with: - registry: docker.io - username: ${{ secrets.dockerhub_username }} - password: ${{ secrets.dockerhub_password }} - if: steps.docker-build.outputs.skipped != 'true' - # quay.io - - id: quay-io-login - name: Login to Quay.io - uses: docker/login-action@v2 - with: - registry: quay.io - username: ${{ secrets.quayio_username }} - password: ${{ secrets.quayio_password }} - if: steps.docker-build.outputs.skipped != 'true' # ghcr.io - id: ghcr-io-login name: Login to GitHub Container Registry diff --git a/README.md b/README.md index e472945..62dc6e1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # netbox-docker +This is OxCERT's fork of the [netbox-docker](https://github.com/netbox-community/netbox-docker/wiki) repository. + +We have a local branch [oxcert](https://github.com/oxcert/netbox-docker/tree/oxcert) which has been set as the default branch in this repository. +The idea is to keep the [release](https://github.com/oxcert/netbox-docker/tree/release) branch in synch with upstream but keep all our changes in +the oxcert branch, from where we build our netbox containers, etc. When there are upstream changes, we merge them in from the release branch. + [![GitHub release (latest by date)](https://img.shields.io/github/v/release/netbox-community/netbox-docker)][github-release] [![GitHub stars](https://img.shields.io/github/stars/netbox-community/netbox-docker)][github-stargazers] ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/netbox-community/netbox-docker) diff --git a/VERSION b/VERSION index 24ba9a3..3eefcb9 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.7.0 +1.0.0 diff --git a/build.sh b/build.sh index fd34029..4497e1d 100755 --- a/build.sh +++ b/build.sh @@ -45,7 +45,7 @@ TAG The version part of the image tag. IMAGE_NAMES The names used for the image including the registry Used for tagging the image. - ${_GREEN}Default:${_CLEAR} docker.io/netboxcommunity/netbox + ${_GREEN}Default:${_CLEAR} ghcr.io/oxcert/netbox ${_CYAN}Example:${_CLEAR} 'docker.io/netboxcommunity/netbox quay.io/netboxcommunity/netbox' DOCKER_TAG The name of the tag which is applied to the image. @@ -143,7 +143,7 @@ source ./build-functions/check-commands.sh source ./build-functions/get-public-image-config.sh source ./build-functions/gh-functions.sh -IMAGE_NAMES="${IMAGE_NAMES-docker.io/netboxcommunity/netbox}" +IMAGE_NAMES="${IMAGE_NAMES-ghcr.io/oxcert/netbox}" IFS=' ' read -ra IMAGE_NAMES <<<"${IMAGE_NAMES}" ### diff --git a/docker-compose.yml b/docker-compose.yml index 38cd658..74ee87f 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ version: '3.4' services: netbox: &netbox - image: docker.io/netboxcommunity/netbox:${VERSION-v3.6-2.7.0} + image: ghcr.io/oxcert/netbox:${VERSION-v3.6-1.0.0} depends_on: - postgres - redis diff --git a/release.sh b/release.sh index 5294799..b89a52a 100755 --- a/release.sh +++ b/release.sh @@ -1,6 +1,6 @@ #!/bin/bash -DEFAULT_REPO=netbox-community/netbox-docker +DEFAULT_REPO=oxcert/netbox-docker REPO="${REPO-${DEFAULT_REPO}}" echomoji() { @@ -105,9 +105,9 @@ check_develop() { } check_release() { - echomoji ๐Ÿ“‹ "?" "Checking 'release' branch" + echomoji ๐Ÿ“‹ "?" "Checking 'oxcert' branch" - check_upstream release + check_upstream oxcert check_clean_repo check_latest } @@ -150,7 +150,7 @@ git_merge() { echo_ok "The branch '${2}' was merged." } -git_merge() { +git_rebase() { echomoji โฉ "ยป" "Rebasing onto '${1}'โ€ฆ" if ! git rebase "${1}"; then echo_nok "Could not rebase onto '${1}'." @@ -170,7 +170,7 @@ check_origin check_develop check_tag -git_switch release +git_switch oxcert check_release echomoji ๐Ÿ“‹ "โ–ถ๏ธŽ" "Releasing '$(