Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: release preparation #49

Merged
merged 1 commit into from
Jul 25, 2023
Merged

chore: release preparation #49

merged 1 commit into from
Jul 25, 2023

Conversation

tenthirtyam
Copy link
Contributor

@tenthirtyam tenthirtyam commented Jul 18, 2023

Summary

  • Updated CHANGELOG.md for release.
  • Updated docs for PowerValidatedSolutions version dependency for release.
  • Added Makefile for local testing.
  • Updated .gitignore to exclude the .site path and files from a local build test.
  • Removed banner and footer link. Will be replaced by digital marketing metrics.

Type

  • Bugfix
  • Enhancement or Feature
  • Code Style or Formatting
  • Documentation
  • Refactoring
  • Chore
  • Other
    Please describe:

Breaking Changes?

  • Yes, there are breaking changes.
  • No, there are no breaking changes.

Test and Documentation

  • Tests have been completed.
  • Documentation has been added or updated.
powershell-module-for-vmware-cloud-foundation-certificate-management on  chore/release-preparation [!?] 
➜ make install
pip install mkdocs-material
Requirement already satisfied: mkdocs-material in /usr/local/lib/python3.10/site-packages (9.1.18)
Requirement already satisfied: colorama>=0.4 in /usr/local/lib/python3.10/site-packages (from mkdocs-material) (0.4.6)
Requirement already satisfied: jinja2>=3.0 in /Users/johnsonryan/Library/Python/3.10/lib/python/site-packages (from mkdocs-material) (3.1.2)
Requirement already satisfied: markdown>=3.2 in /usr/local/lib/python3.10/site-packages (from mkdocs-material) (3.3.7)
Requirement already satisfied: mkdocs-material-extensions>=1.1 in /usr/local/lib/python3.10/site-packages (from mkdocs-material) (1.1.1)
Requirement already satisfied: mkdocs>=1.4.2 in /usr/local/lib/python3.10/site-packages (from mkdocs-material) (1.4.3)
Requirement already satisfied: pygments>=2.14 in /usr/local/lib/python3.10/site-packages (from mkdocs-material) (2.15.1)
Requirement already satisfied: pymdown-extensions>=9.9.1 in /usr/local/lib/python3.10/site-packages (from mkdocs-material) (9.11)
Requirement already satisfied: regex>=2022.4.24 in /usr/local/lib/python3.10/site-packages (from mkdocs-material) (2023.5.5)
Requirement already satisfied: requests>=2.26 in /usr/local/lib/python3.10/site-packages (from mkdocs-material) (2.28.2)
Requirement already satisfied: MarkupSafe>=2.0 in /Users/johnsonryan/Library/Python/3.10/lib/python/site-packages (from jinja2>=3.0->mkdocs-material) (2.1.1)
Requirement already satisfied: click>=7.0 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.4.2->mkdocs-material) (8.1.3)
Requirement already satisfied: ghp-import>=1.0 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.4.2->mkdocs-material) (2.1.0)
Requirement already satisfied: mergedeep>=1.3.4 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.4.2->mkdocs-material) (1.3.4)
Requirement already satisfied: packaging>=20.5 in /Users/johnsonryan/Library/Python/3.10/lib/python/site-packages (from mkdocs>=1.4.2->mkdocs-material) (21.3)
Requirement already satisfied: pyyaml-env-tag>=0.1 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.4.2->mkdocs-material) (0.1)
Requirement already satisfied: pyyaml>=5.1 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.4.2->mkdocs-material) (6.0)
Requirement already satisfied: watchdog>=2.0 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.4.2->mkdocs-material) (3.0.0)
Requirement already satisfied: charset-normalizer<4,>=2 in /usr/local/lib/python3.10/site-packages (from requests>=2.26->mkdocs-material) (3.0.1)
Requirement already satisfied: idna<4,>=2.5 in /usr/local/lib/python3.10/site-packages (from requests>=2.26->mkdocs-material) (3.4)
Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/local/lib/python3.10/site-packages (from requests>=2.26->mkdocs-material) (1.26.14)
Requirement already satisfied: certifi>=2017.4.17 in /usr/local/lib/python3.10/site-packages (from requests>=2.26->mkdocs-material) (2022.12.7)
Requirement already satisfied: python-dateutil>=2.8.1 in /usr/local/lib/python3.10/site-packages (from ghp-import>=1.0->mkdocs>=1.4.2->mkdocs-material) (2.8.2)
Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /Users/johnsonryan/Library/Python/3.10/lib/python/site-packages (from packaging>=20.5->mkdocs>=1.4.2->mkdocs-material) (3.0.9)
Requirement already satisfied: six>=1.5 in /usr/local/lib/python3.10/site-packages (from python-dateutil>=2.8.1->ghp-import>=1.0->mkdocs>=1.4.2->mkdocs-material) (1.16.0)
pip install --requirement docs/requirements.txt
Requirement already satisfied: mkdocs-git-authors-plugin>=0.7.0 in /usr/local/lib/python3.10/site-packages (from -r docs/requirements.txt (line 1)) (0.7.2)
Requirement already satisfied: mkdocs-git-revision-date-localized-plugin>=1.2.0 in /usr/local/lib/python3.10/site-packages (from -r docs/requirements.txt (line 2)) (1.2.0)
Requirement already satisfied: mkdocs-markdownextradata-plugin>=0.2.5 in /usr/local/lib/python3.10/site-packages (from -r docs/requirements.txt (line 3)) (0.2.5)
Requirement already satisfied: mkdocs-minify-plugin>=0.6.4 in /usr/local/lib/python3.10/site-packages (from -r docs/requirements.txt (line 4)) (0.6.4)
Requirement already satisfied: mkdocs-open-in-new-tab>=1.0.2 in /usr/local/lib/python3.10/site-packages (from -r docs/requirements.txt (line 5)) (1.0.2)
Requirement already satisfied: mkdocs>=1.0 in /usr/local/lib/python3.10/site-packages (from mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (1.4.3)
Requirement already satisfied: GitPython in /usr/local/lib/python3.10/site-packages (from mkdocs-git-revision-date-localized-plugin>=1.2.0->-r docs/requirements.txt (line 2)) (3.1.32)
Requirement already satisfied: babel>=2.7.0 in /usr/local/lib/python3.10/site-packages (from mkdocs-git-revision-date-localized-plugin>=1.2.0->-r docs/requirements.txt (line 2)) (2.12.1)
Requirement already satisfied: pytz in /usr/local/lib/python3.10/site-packages (from mkdocs-git-revision-date-localized-plugin>=1.2.0->-r docs/requirements.txt (line 2)) (2023.3)
Requirement already satisfied: pyyaml in /usr/local/lib/python3.10/site-packages (from mkdocs-markdownextradata-plugin>=0.2.5->-r docs/requirements.txt (line 3)) (6.0)
Requirement already satisfied: htmlmin2>=0.1.13 in /usr/local/lib/python3.10/site-packages (from mkdocs-minify-plugin>=0.6.4->-r docs/requirements.txt (line 4)) (0.1.13)
Requirement already satisfied: jsmin>=3.0.1 in /usr/local/lib/python3.10/site-packages (from mkdocs-minify-plugin>=0.6.4->-r docs/requirements.txt (line 4)) (3.0.1)
Requirement already satisfied: csscompressor>=0.9.5 in /usr/local/lib/python3.10/site-packages (from mkdocs-minify-plugin>=0.6.4->-r docs/requirements.txt (line 4)) (0.9.5)
Requirement already satisfied: click>=7.0 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (8.1.3)
Requirement already satisfied: ghp-import>=1.0 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (2.1.0)
Requirement already satisfied: jinja2>=2.11.1 in /Users/johnsonryan/Library/Python/3.10/lib/python/site-packages (from mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (3.1.2)
Requirement already satisfied: markdown<3.4,>=3.2.1 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (3.3.7)
Requirement already satisfied: mergedeep>=1.3.4 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (1.3.4)
Requirement already satisfied: packaging>=20.5 in /Users/johnsonryan/Library/Python/3.10/lib/python/site-packages (from mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (21.3)
Requirement already satisfied: pyyaml-env-tag>=0.1 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (0.1)
Requirement already satisfied: watchdog>=2.0 in /usr/local/lib/python3.10/site-packages (from mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (3.0.0)
Requirement already satisfied: gitdb<5,>=4.0.1 in /usr/local/lib/python3.10/site-packages (from GitPython->mkdocs-git-revision-date-localized-plugin>=1.2.0->-r docs/requirements.txt (line 2)) (4.0.10)
Requirement already satisfied: python-dateutil>=2.8.1 in /usr/local/lib/python3.10/site-packages (from ghp-import>=1.0->mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (2.8.2)
Requirement already satisfied: smmap<6,>=3.0.1 in /usr/local/lib/python3.10/site-packages (from gitdb<5,>=4.0.1->GitPython->mkdocs-git-revision-date-localized-plugin>=1.2.0->-r docs/requirements.txt (line 2)) (5.0.0)
Requirement already satisfied: MarkupSafe>=2.0 in /Users/johnsonryan/Library/Python/3.10/lib/python/site-packages (from jinja2>=2.11.1->mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (2.1.1)
Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /Users/johnsonryan/Library/Python/3.10/lib/python/site-packages (from packaging>=20.5->mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (3.0.9)
Requirement already satisfied: six>=1.5 in /usr/local/lib/python3.10/site-packages (from python-dateutil>=2.8.1->ghp-import>=1.0->mkdocs>=1.0->mkdocs-git-authors-plugin>=0.7.0->-r docs/requirements.txt (line 1)) (1.16.0)

powershell-module-for-vmware-cloud-foundation-certificate-management on  chore/release-preparation [!?] 
➜ make serve-live
mkdocs serve --livereload -w ./
INFO     -  Building documentation...
INFO     -  Cleaning site directory
INFO     -  Documentation built in 1.45 seconds
INFO     -  [10:46:15] Watching paths for changes: 'docs',
            'mkdocs.yml', '.'
INFO     -  [10:46:15] Serving on
            http://127.0.0.1:8000/powershell-module-for-vmware-cloud-foundation-certificate-management/
WARNING  -  [10:46:24] "GET /versions.json HTTP/1.1" code 404
INFO     -  [10:46:24] Browser connected:
            http://127.0.0.1:8000/powershell-module-for-vmware-cloud-foundation-certificate-management/
WARNING  -  [10:46:28] "GET /versions.json HTTP/1.1" code 404
INFO     -  [10:46:28] Browser connected:
            http://127.0.0.1:8000/powershell-module-for-vmware-cloud-foundation-certificate-management/
INFO     -  [10:47:20] Detected file changes
INFO     -  Building documentation...
INFO     -  Documentation built in 1.50 seconds
INFO     -  [10:47:21] Reloading browsers
INFO     -  [10:47:44] Detected file changes
INFO     -  Building documentation...
INFO     -  Documentation built in 1.42 seconds
INFO     -  [10:47:46] Reloading browsers
INFO     -  [10:58:00] Detected file changes
INFO     -  Building documentation...
INFO     -  Documentation built in 1.65 seconds
INFO     -  [10:58:02] Reloading browsers
INFO     -  [10:58:03] Detected file changes
INFO     -  Building documentation...
INFO     -  Documentation built in 1.58 seconds
INFO     -  [10:58:05] Reloading browsers
INFO     -  [10:58:05] Detected file changes
INFO     -  Building documentation...
INFO     -  Documentation built in 1.51 seconds
INFO     -  [10:58:06] Reloading browsers
INFO     -  [10:59:06] Detected file changes
INFO     -  Building documentation...
INFO     -  [10:59:08] Reloading browsers
INFO     -  [10:59:08] Detected file changes
INFO     -  Building documentation...
INFO     -  [10:59:09] Reloading browsers

Issue References

Additional Information

@tenthirtyam tenthirtyam added the chore Chore label Jul 18, 2023
@tenthirtyam tenthirtyam added this to the v1.2.0 milestone Jul 18, 2023
@tenthirtyam tenthirtyam self-assigned this Jul 18, 2023
@vmwclabot vmwclabot added the cla-not-required CLA Not Required label Jul 18, 2023
@github-actions github-actions bot added documentation Documentation needs-review Needs Review labels Jul 18, 2023
@tenthirtyam tenthirtyam force-pushed the chore/release-preparation branch 4 times, most recently from 9b600d6 to 1fbb97f Compare July 24, 2023 20:31
@tenthirtyam tenthirtyam marked this pull request as ready for review July 24, 2023 20:32
@tenthirtyam tenthirtyam requested a review from a team as a code owner July 24, 2023 20:32
- Updated `CHANGELOG.md` for release.
- Updated docs for `PowerValidatedSolutions` version dependency for release.
- Added `Makefile` for local testing.
- Updated `.gitignore` to exclude the `.site` path and files from a local build test.
- Removed banner and footer link.

Signed-off-by: Ryan Johnson <johnsonryan@vmware.com>
@GaryJBlake GaryJBlake removed the needs-review Needs Review label Jul 25, 2023
Copy link
Contributor

@GaryJBlake GaryJBlake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@GaryJBlake GaryJBlake merged commit 12b987a into main Jul 25, 2023
2 checks passed
@GaryJBlake GaryJBlake deleted the chore/release-preparation branch July 25, 2023 07:52
@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
chore Chore cla-not-required CLA Not Required documentation Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants