From e4ef095254b6349f15a9b51e46619d43a2d6dc87 Mon Sep 17 00:00:00 2001 From: Jamie Curnow Date: Tue, 9 Jan 2024 08:36:32 +1000 Subject: [PATCH] Deploy develop docs in CI, updated readme --- Jenkinsfile | 35 +++++++++++++++++++++++++---------- README.md | 16 +++++++++++++--- 2 files changed, 38 insertions(+), 13 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index ca32bcc5..daaa9f47 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -22,8 +22,6 @@ pipeline { COMPOSE_FILE = 'docker/docker-compose.ci.yml' COMPOSE_INTERACTIVE_NO_CLI = 1 BUILDX_NAME = "${COMPOSE_PROJECT_NAME}" - DOCS_BUCKET = 'jc21-npm-site' - DOCS_CDN = 'EN1G6DEWZUTDT' } stages { stage('Environment') { @@ -175,16 +173,33 @@ pipeline { } } stage('Docs Deploy') { - when { - allOf { - branch 'master' - not { - equals expected: 'UNSTABLE', actual: currentBuild.result + parallel { + stage('Master') { + when { + allOf { + branch 'master' + not { + equals expected: 'UNSTABLE', actual: currentBuild.result + } + } + } + steps { + npmDocsReleaseMaster() + } + } + stage('Develop') { + when { + allOf { + branch 'develop' + not { + equals expected: 'UNSTABLE', actual: currentBuild.result + } + } + } + steps { + npmDocsReleaseDevelop() } } - } - steps { - npmDocsRelease("$DOCS_BUCKET", "$DOCS_CDN") } } stage('PR Comment') { diff --git a/README.md b/README.md index 0bad17f6..c4177394 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,18 @@ Password: changeme Immediately after logging in with this default user you will be asked to modify your details and change your password. -## Contributors +## Contributing + +All are welcome to create pull requests for this project, against the `develop` branch. Official releases are created from the `master` branch. + +CI is used in this project. All PR's must pass before being considered. After passing, +docker builds for PR's are available on dockerhub for manual verifications. + +Documentation within the `develop` branch is available for preview at +[https://develop.nginxproxymanager.com](https://develop.nginxproxymanager.com) + + +### Contributors Special thanks to [all of our contributors](https://github.com/NginxProxyManager/nginx-proxy-manager/graphs/contributors). @@ -107,5 +118,4 @@ Special thanks to [all of our contributors](https://github.com/NginxProxyManager 1. [Found a bug?](https://github.com/NginxProxyManager/nginx-proxy-manager/issues) 2. [Discussions](https://github.com/NginxProxyManager/nginx-proxy-manager/discussions) -3. [Development Gitter](https://gitter.im/nginx-proxy-manager/community) -4. [Reddit](https://reddit.com/r/nginxproxymanager) +3. [Reddit](https://reddit.com/r/nginxproxymanager)