From c1dcf59684da0dc0648337545bab5eb4c2f8806d Mon Sep 17 00:00:00 2001 From: SWB Date: Thu, 16 Mar 2023 11:04:50 +0000 Subject: [PATCH] add jenkinsfile and CNAME file (#102) The current implementation of the site builder requires content repo to be submited as a zip file for production using env vars `CONTENT_SOURCE_TYPE=git` and `CONTENT_SOURCE_URL=repo-link.zip` which is not considered a best practice. Due to this, a race condition may occur during the build process if another commit is made while the build is in progress which may lead a security flow. To work around this,first, we checkout into `src` using `checkoutToSubdirectory('src')`. Then, we use `local_folder` mode using `CONTENT_SOURCE_TYPE=local_folder` and `CONTENT_SOURCE_URL=..src` env vars, just like a local develop. `local_folder` mode copies the website files from `src` into `docs` because the site builder is incapable of copying it. We checkout the builder into the `builder` directory and run the `install` and `build` commands inside of that directory. Finally, for publish stages, we copy the `out` directory into the site repo, since the out directory is in the wrong repo. --- Jenkinsfile | 85 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 12 +++---- static-assets/CNAME | 1 + 3 files changed, 92 insertions(+), 6 deletions(-) create mode 100644 Jenkinsfile create mode 100644 static-assets/CNAME diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..a9125f7 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,85 @@ +pipeline { + agent { label 'linux' } + + options { + disableConcurrentBuilds() + /* Necessary for logos-side-builder local_folder source type. */ + checkoutToSubdirectory('src') + /* manage how many builds we keep */ + buildDiscarder(logRotator( + numToKeepStr: '20', + daysToKeepStr: '30', + )) + } + + environment { + /* Mode of logos-site-builder for copying site source from already checked out repo. + * TODO: Avoid copying anything at all, make checkout site of into `docs` folder work. */ + CONTENT_SOURCE_TYPE = 'local_folder' + CONTENT_SOURCE_URL = '../src' + GIT_COMMITTER_NAME = 'status-im-auto' + GIT_COMMITTER_EMAIL = 'auto@status.im' + /* dev page settings */ + DEV_SITE = 'dev.vac.dev' + DEV_HOST = 'jenkins@node-01.do-ams3.sites.misc.statusim.net' + SCP_OPTS = 'StrictHostKeyChecking=no' + } + + stages { + stage('Clone Builder') { + steps { + dir('builder') { + checkout([$class: 'GitSCM', + branches: [[name: 'v0']], + userRemoteConfigs: [[url: 'https://github.com/acid-info/logos-site-builder']]]) + } + } + } + + stage('Install') { + steps { + dir('builder') { + sh 'yarn install' + } + } + } + + stage('Build') { + steps { + dir('builder') { + sh 'yarn build' + } + } + } + + stage('Publish Prod') { + when { expression { env.GIT_BRANCH ==~ /.*master/ } } + steps { + dir('src') { + sh 'cp -r ../builder/out ./' + sshagent(credentials: ['status-im-auto-ssh']) { + sh "ghp-import -p out" + } + } + } + } + + stage('Publish Devel') { + when { expression { env.GIT_BRANCH ==~ /.*develop/ } } + steps { + dir('builder') { + sshagent(credentials: ['jenkins-ssh']) { + sh """ + rsync -e 'ssh -o ${SCP_OPTS}' -r --delete out/. \ + ${env.DEV_HOST}:/var/www/${env.DEV_SITE}/ + """ + } + } + } + } + } + + post { + cleanup { cleanWs() } + } +} diff --git a/README.md b/README.md index 258a140..5c03924 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ Made and deployed with [logos site-builder](https://github.com/acid-info/logos-s # Continuous Deloyment -- `staging` branch is deployed to [staging.vac.dev](https://staging.vac.dev) -- `master` branch is deployed to [vac.dev](https://vac.dev) +* `master` branch is deployed to https://vac.dev by [CI](https://ci.infra.status.im/job/website/job/vac.dev/) +- `develop` branch is deployed to https://dev.vac.dev by [CI](https://ci.infra.status.im/job/website/job/dev.vac.dev/) # Change Process -1. Create a new working branch from `staging`: `git checkout staging; git checkout -b my-changes`; -2. Proceed with changes, push to `origin` and open a Pull Request against `staging`; -3. Once approved, merge pull request, check changes on [staging.vac.dev](https://staging.vac.dev); -4. Once ready to promote to live website, rebase master on staging: `git checkout master; git pull master; git rebase origin/staging; git push`. +1. Create a new working branch from `develop`: `git checkout develop; git checkout -b my-changes`; +2. Proceed with changes, push to `origin` and open a Pull Request against `develop`; +3. Once approved, merge pull request, check changes on [dev.vac.dev](https://dev.vac.dev); +4. Once ready to promote to live website, rebase master on staging: `git checkout master; git pull master; git rebase origin/develop; git push`. # Copyright diff --git a/static-assets/CNAME b/static-assets/CNAME new file mode 100644 index 0000000..8152256 --- /dev/null +++ b/static-assets/CNAME @@ -0,0 +1 @@ +vac.dev \ No newline at end of file