diff --git a/README.md b/README.md index f5fe746..f2ac0af 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Orcid WordPress Homepage Deployment -The purpose of this repository is to provide a straightforward method for both technical and non-technical users to deploy a clone of a WordPress post from https://info.qa.orcid.org/ and https://info.orcid.org/. +The purpose of this repository is to provide a straightforward method for both technical and non-technical users to deploy a clone of a WordPress post from https://info.qa.orcid.org/ ## Homepage QA Deploy @@ -8,32 +8,38 @@ Deploy the info.qa.orcid.org page on qa.orcid.org: - Navigate to [Homepage QA Deploy](https://github.com/ORCID/orcid-wordpress-home-page-deploy/actions/workflows/qa-deploy.yml) - Click on "Run workflow" - - Select environment = `STAGIN` and select the WordPress post that needs to be deployed (default is `25163`) - + - Select `Create a versioned artifact? = false` and select the WordPress post that needs to be deployed (default is `25422`) +image -``` -Note: -TODO: Provide more info to users who might not know how to get the post id -from the WordPress post they want to publish. -``` ## Homepage PROD Deploy -Deploy the info.orcid.org page on orcid.org - -1. Before deploying it to prod, verify the info.orcid.org post on qa.orcid.org +1. Before deploying it to prod run a QA release that will create a versioned artifact - Navigate to [Homepage QA Deploy](https://github.com/ORCID/orcid-wordpress-home-page-deploy/actions/workflows/qa-deploy.yml) - Click on "Run workflow" - - Select environment = `PROD` and select the Prod WordPress post that needs to be deployed + - Select `Create a versioned artifact? = true` and select the Prod WordPress post that needs to be deployed (default is 25422) + - The created artifact is now published on qa.orcid.org. Please make sure with your team that this is approved for production before continuing. -2. Deploy the info.orcid.org page to prod: +2. Deploy the version of this artifact to production - Navigate to [Homepage PROD Deploy](https://github.com/ORCID/orcid-wordpress-home-page-deploy/actions/workflows/prod-deploy.yml) - - -- WIP 👷‍♂️ --- + - Click on "Run workflow" + - And run the latest version displayed on the [(release list page) ](https://github.com/ORCID/orcid-wordpress-home-page-deploy/releases). + - The release will occur in three stages: a release to QA (for a final review), a release to the production-fallback machine, and a release to the production machine. + - Before the fallback-production and production releases, you will be asked to review the previous release. You will need to approve this to continue. As show on the following image: + - image + + +3. Document the date this release version was put up on production + - Navigate to the release list version, click "Edit," and add a note about the release date for the production version. This information will provide better context for identifying the last stable version if a rollback is necessary. image + + ## Rollback Deployment --- WIP 👷‍♂️ --- + - Navigate to [Homepage PROD Deploy](https://github.com/ORCID/orcid-wordpress-home-page-deploy/actions/workflows/prod-deploy.yml) + - Click on "Run workflow" + - And run the version you want to deploy to production [(see the full list on versioned artifacts apps) ](https://github.com/ORCID/orcid-wordpress-home-page-deploy/releases) ## Developers @@ -44,14 +50,6 @@ Running the following command will run the cloning process on your local environ ``` export GITHUB_OUTPUT="./dist/output" export GITHUB_STEP_SUMMARY="./dist/summary" -python3 wordpress-cloning-main.py PROD 27308 orcidstaging fb8dd998 +python3 wordpress-cloning-main.py STAGE 25422 orcidstaging fb8dd998 --dry-run ``` -If changes need to be committed run (This won't deploy to S3, or create a GitHub releases) - -``` -export GITHUB_OUTPUT="./dist/output" -export GITHUB_STEP_SUMMARY="./dist/summary" -python3 wordpress-cloning-main.py PROD 27308 orcidstaging fb8dd998 -``` --- WIP 👷‍♂️ --- diff --git a/dist/index.html b/dist/index.html index 993d87f..19be7e5 100644 --- a/dist/index.html +++ b/dist/index.html @@ -1,3 +1,4 @@ +
diff --git a/package.json b/package.json index 6163a32..f172ee6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "orcid-wordpress-home-page-deploy", - "version": "v0.1.42", + "version": "v0.1.43", "description": "", "main": "index.js", "type": "module", @@ -30,4 +30,4 @@ "dependencies": { "line-reader": "^0.4.0" } -} +} \ No newline at end of file