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: Update examples link during release process #2148

Merged
merged 4 commits into from
Apr 15, 2024

Conversation

AgustinBettati
Copy link
Member

@AgustinBettati AgustinBettati commented Apr 15, 2024

Description

Link to any related issue(s): CLOUDP-238066

Adds new step in release workflow to update how we reference the examples section from our terraform index page documentation.

Testing

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contributing guides
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

type: string

jobs:
run_script_and_commit:
Copy link
Member Author

Choose a reason for hiding this comment

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

extracted this as it will also contain logic for commit signing and configuring github PAT.

@AgustinBettati AgustinBettati marked this pull request as ready for review April 15, 2024 12:16
@AgustinBettati AgustinBettati requested a review from a team as a code owner April 15, 2024 12:16
NEW_URL="\[example configurations\](https:\/\/github.com\/mongodb\/terraform-provider-mongodbatlas\/tree\/$RELEASE_TAG\/examples)"


TMP_FILE_NAME="docs.tmp"
Copy link
Collaborator

Choose a reason for hiding this comment

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

[nit] Curious why we are not using "in-place" (-I flag)?

Copy link
Member Author

Choose a reason for hiding this comment

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

Went for this approach initially but the implementation of sed in macOS vs Linux handles the -i parameter differently. Opted for having same behaviour in CI vs running locally by simplifying how the command is invoked.

Copy link
Collaborator

@EspenAlbert EspenAlbert left a comment

Choose a reason for hiding this comment

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

LGMT 👍

@AgustinBettati AgustinBettati merged commit eb01c2d into master Apr 15, 2024
62 checks passed
@AgustinBettati AgustinBettati deleted the CLOUDP-238066 branch April 15, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants