From ba76a89f267cde70aefae1793643bad288808701 Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Thu, 1 Aug 2024 09:48:14 +0100 Subject: [PATCH] Emoji markdown Fix (#4031) * update * update mkdocs * Release v0.18 (#4016) * update release.md * spelling * update changelog * moved to different branch * Databricks ips (#3964) * Fix hash issue with builds (#4013) * Fix hash issue with builds * Update build.test.js --------- Co-authored-by: Marcus Robinson * Support custom domain on SSL certificate and App Registration redirect (#4014) * Support custom domain on SSL certificate and App Registration redirect * Update CHANGELOG.md * Update core version number * Custom domain documentation * Fix docs formatting * Update CHANGELOG.md * Print certificate FQDN to console in letsencrypt.sh * Add user case studies to docs (#4025) * update changelog * update * update --------- Co-authored-by: Marcus Robinson Co-authored-by: Jonny Rylands --- CHANGELOG.md | 1 + docs/tre-developers/release.md | 34 ++++++++++++++++++---------------- mkdocs.yml | 3 +++ 3 files changed, 22 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 53e7badc25..93f133c5dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,7 @@ ENHANCEMENTS: BUG FIXES: * Fix numbering issue within `bug_report.md` template ([#4028](https://github.com/microsoft/AzureTRE/pull/4028)) * Disable public network access to the API App Service ([#3986](https://github.com/microsoft/AzureTRE/issues/3986)) +* Update Docs to format emojis properly ([#4027](https://github.com/microsoft/AzureTRE/issues/4027)) COMPONENTS: diff --git a/docs/tre-developers/release.md b/docs/tre-developers/release.md index 63758bff65..ce7a362566 100644 --- a/docs/tre-developers/release.md +++ b/docs/tre-developers/release.md @@ -4,24 +4,26 @@ A release is created when enough changes have been made and the main branch is s The process follows these steps: -1. Update `CHANGELOG.md` in a PR with the following: - 1. Rename the top-most verion noted as unreleaed with the version number that makes sense. Note that you don't have to keep the one that is currently in the file as the version number chosen should reflect the changes made (major, minor, etc.) - 1. Create a new section for the next-unreleaed version so that future changes will be placed there. - 1. Run `devops/scripts/list_versions.sh` and include the output in the change log for the version you're about the release -1. Merge the PR -1. Create a GitHub Release +1. Create a `Prep for Release v0...` issue to track. +2. Create PR linked to the `Prep...` issue and open in Dev Container. +3. Update `CHANGELOG.md` in a PR with the following: + 1. Rename the top-most version noted as unreleased with the version number that makes sense. Note that you don't have to keep the one that is currently in the file as the version number chosen should reflect the changes made (major, minor, etc.) + 2. Create a new section for the next-unreleased version so that future changes will be placed there. + 3. Run `devops/scripts/list_versions.sh` and include the output in the change log for the version you're about the release +4. Merge the PR +5. Create GitHub Release in `Pre Release` state. 1. Go to https://github.com/microsoft/AzureTRE/releases/new - 1. Click on `Choose a tag` and type a new one for you version. It should be in the form of `v0.9.2` - note the "v" in the begining. - 1. The release title should be just the version number "0.9.2" in the example above. - 1. Copy the text from the CHANGELOG.md file and paste in the release description. - 1. Include a final line with a link to the full changelog similar to this: + 2. Click on `Choose a tag` and type a new one for you version. It should be in the form of `v0.9.2` - note the "v" in the beginning. + 3. The release title should be just the version number "0.9.2" in the example above. + 4. Copy the text from the CHANGELOG.md file and paste in the release description. + 5. Include a final line with a link to the full changelog similar to this: **Full Changelog**: https://github.com/microsoft/AzureTRE/compare/v0.9.1...v0.9.2 - -1. Update [AzureTRE-Deployment](https://github.com/microsoft/AzureTRE-Deployment). The procedure may vary depending on the level of changes introduced in the new version but should include the following steps: +6. Update [AzureTRE-Deployment](https://github.com/microsoft/AzureTRE-Deployment). The procedure may vary depending on the level of changes introduced in the new version but should include the following steps: 1. Update the tag used in [devcontainer.json](https://github.com/microsoft/AzureTRE-Deployment/blob/main/.devcontainer/devcontainer.json). - 1. Rebuild the container. - 1. Compare both `.devcontainer` and `.github` folders of the new release with the ones in the repo and make required updates so that only required difference exist. - The comapre can be done with VSCode [Compare Folders extension](https://marketplace.visualstudio.com/items?itemName=moshfeu.compare-folders) as you have both the old version (under to root folder) and the "new" one inside the _AzureTRE_ symlink. - 1. With all changes made, rebuild the container to verify it's working and that AzureTRE folder has been populated correctly. + 2. Rebuild the container. + 3. Compare both `.devcontainer` and `.github` folders of the new release with the ones in the repo and make required updates so that only required difference exist. + The compare can be done with VSCode [Compare Folders extension](https://marketplace.visualstudio.com/items?itemName=moshfeu.compare-folders) as you have both the old version (under to root folder) and the "new" one inside the _AzureTRE_ symlink. + 4. With all changes made, rebuild the container to verify it's working and that AzureTRE folder has been populated correctly. +7. Once tests have been complete edit GitHub Release to `Set as the latest release`. diff --git a/mkdocs.yml b/mkdocs.yml index 886992b882..a4e2aa3d2c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,6 +43,9 @@ markdown_extensions: - mdx_truly_sane_lists - pymdownx.tabbed - pymdownx.tasklist + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg nav: - Overview: # Pages to explain what the Azure TRE