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.

Sign up for GitHub

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

Jump to bottom

feat: add dynamic update the list of related references #273

Merged
merged 7 commits into from
Jan 28, 2021
Merged

feat: add dynamic update the list of related references #273

merged 7 commits into from
Jan 28, 2021

Conversation

SweetOps
Copy link
Contributor

what

  • add script that will dynamically update the list of related references in the README.yaml

references

  • CPCO-361

@SweetOps SweetOps added wip Work in Progress: Not ready for final review or merge and removed modules/readme labels Jan 19, 2021
github-actions[bot]
github-actions bot reviewed Jan 19, 2021
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for submitting this PR! If you haven't already joined our slack community, then we invite you to do so.

We receive an overwhelming number of contributions. By joining our slack, we'll be able to review your PR faster.

Slack Community

@SweetOps SweetOps marked this pull request as ready for review January 25, 2021 19:56
@SweetOps SweetOps requested review from a team as code owners January 25, 2021 19:56
osterman
osterman reviewed Jan 25, 2021
View reviewed changes
bin/generate_related_references.py Outdated


if __name__ == "__main__":
related_reference_list = []
Copy link
Member

Choose a reason for hiding this comment

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

So related and references are two separate sections of the README.

The related is for modules relates to this one.

The references section is for links to documentation (links to providers, link to AWS docs, etc) to read more, for example.

@osterman
Copy link
Member

Can you use your branch to open a PR against some of our modules so we can validate the results?

E.g. terraform-aws-eks

@SweetOps
Copy link
Contributor Author

Can you use your branch to open a PR against some of our modules so we can validate the results?

cloudposse/terraform-aws-eks-cluster#98 generated by command:

docker run --rm -e GH_TOKEN=change_me \
-e GH_SEARCH_PATTERN=terraform-aws-eks \
-v /local_path_to_repo/terraform-aws-eks-cluster:/home/test \
build-harness:test readme/generate-related-reference

@SweetOps SweetOps removed the wip Work in Progress: Not ready for final review or merge label Jan 27, 2021
osterman
osterman approved these changes Jan 28, 2021
View reviewed changes
Copy link
Member

@osterman osterman left a comment

Choose a reason for hiding this comment

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

LGTM!

@SweetOps SweetOps merged commit 563d373 into master Jan 28, 2021
@SweetOps SweetOps deleted the CPCO-361 branch January 28, 2021 19:51
ray-harris added a commit to stolostron/build-harness that referenced this pull request Nov 16, 2021
@ray-harris @schmidtd
@aknysh @hassenius @osterman @cloudpossebot @Gowiem @Nuru @maximmi @mcalhoun @SweetOps @lorengordon
merge upstream (#3)
cefdd3c 
* Let build-harness know what OS we're on (cloudposse#195)

* Add Slash Command Dispatch GitHub Actions template (cloudposse#197)

* Update Slash Command Dispatch GitHub Actions templates

* Update Slash Command Dispatch GitHub Actions templates

* Update Slash Command Dispatch GitHub Actions template

* suppress detachedhead advise on versioned tag install (cloudposse#199)

Thanks! Makes sense...

* Add discourse badges (cloudposse#200)

* fix gomplate install

* rebuild readme

* Update README.md (cloudposse#201)

Co-authored-by: osterman <osterman@users.noreply.github.com>

Co-authored-by: Cloud Posse Bot (CI/CD) <ops@cloudposse.com>
Co-authored-by: osterman <osterman@users.noreply.github.com>

* Fixes cloudposse#149, tf/lint on mac xargs does not support --no-run-if-empty (cloudposse#206)

* fix dispatch template paths (cloudposse#211)

* fix dispatch template paths

* remove duplicate target

* Use github actions to build and push (cloudposse#213)

* Use github actions to build and push

* Update readme

* rename to docker

* rename to docker

* update descriptions

* build-and-push

* Update readme

* more renaming

* Update .github/workflows/build-and-push.yml

Co-authored-by: Andriy Knysh <aknysh@users.noreply.github.com>

Co-authored-by: Andriy Knysh <aknysh@users.noreply.github.com>

* fix issue template (cloudposse#215)

* add test workflow (cloudposse#212)

* add test workflow

* bump versions

* add test command

* rename to chatops

* drop slash command (cloudposse#216)

* Update codeowners (cloudposse#217)

* Fix terraform docs (cloudposse#218)

* build image on releases (cloudposse#219)

* Fix assert-set (cloudposse#220)

* Fix assert-set

* Update description

* use native make to test variables

* reenable deps-dev

* use native make error handling

* add yq (cloudposse#222)

* Changes to support README.md to passing super-linter (cloudposse#230)

* MD changes to pass linting

* Additional changes

* Built readme

* CR changes

* Create ignore file by default

* Change description to better match docs/deps

* Change linter ignore to according type

* Fix MD040/fenced-code-language lint error

* Ignore just part of violating MD file

* Ignore MD041 for whole file targets.md

* Ignore linting all docs/*.md files

* Update README template to pass lint and add gh action superlinter  (cloudposse#232)

* Update README template to pass lint

In PR against `terraform-example-module` I ran into [issue with superlint](https://github.com/cloudposse/terraform-example-module/pull/3/checks?check_run_id=928328375)
> ERROR:[README.md:240 MD046/code-block-style Code block style [Expected: fenced; Actual: indented]]

Here is documentation about it:
https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md046---code-block-style

* Additional fix for another lint failure

* Convert licenses to code and add superlint to gh actions

* Fix readme

* Remove ending white characters'

* add auto-release action (cloudposse#238)

* refine auto release (cloudposse#239)

* Expand auto-releasers configuration (cloudposse#240)

* use labels

* fix auto labels

* Update Release Template (cloudposse#241)

* Update chatops (cloudposse#236)

* update chatops permissions

* update chatops

* Update .github/workflows/chatops.yml

Co-authored-by: Nuru <Nuru@users.noreply.github.com>

* Update .github/workflows/chatops.yml

Co-authored-by: Nuru <Nuru@users.noreply.github.com>

* update slash-command-dispatch

Co-authored-by: Nuru <Nuru@users.noreply.github.com>

* Fix module upgrade script (cloudposse#243)

* Fix module upgrade script

* update deps

* Add context.tf to CODEOWNERS (cloudposse#245)

* Fixing superlint terraform docs check for inherited markdown files (cloudposse#244)

* Update auto-release and docker workflow to push release tags (cloudposse#249)

* terraform/migrate-to-registry Makefile target added (cloudposse#258)

* terraform/migrate-to-registry Makefile target added

* target renamed

* readme rebuilded

* markdown linter rules fix to avoid raising errors for lines longer then 400 chars

* full linter config applied

* terraform format for examples as well

* markdownlint disabled for contributors table

* regex fix

* readme fix

* readme fix

* linter rules removed, no need for them any more

* new target to remove upper bound for terraform core version constraint (cloudposse#261)

* Add support for Terraform 0.14 (cloudposse#262)

* fix broken interpolation (cloudposse#265)

* Add commands to help create pull requests (cloudposse#266)

* Add renovate config to Terraform modules (cloudposse#267)

* Support more automation (cloudposse#268)

* RUNNER_DOCKER_IMAGE was missing for 'builder' target (cloudposse#269)

* [auto-context] Open PR (as cloudpossebot) when context.tf changes (cloudposse#270)

* feat: add dynamic update the lists of related and references (cloudposse#273)

* Update README.md Template with BridgeCrew Compliance Badges (cloudposse#256)

* Update README.md Template with BridgeCrew Compliance Badges

* template fixes

* Security & Compliance section shown only for terraform modules

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>

* approvers now allowed to review all *.tf files (cloudposse#277)

* approvers now allowed to review all *.tf files

* README.yaml added for approvers

* mergify rule to close PRs without changes (cloudposse#280)

* mergify rule to close PRs without changes

* Update templates/terraform/.github/mergify.yml

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>

* nightly build added before midnight to prepare build-harness images before most of nightly build fires (cloudposse#281)

* integration of generate-related-references target (cloudposse#282)

* remove generate-related-references target from auto-format (cloudposse#283)

* auto-release respect 'no-release' label (cloudposse#279)

* Adds auto-init capability using the bootstrap include directive (cloudposse#272)

* bugfix (cloudposse#285)

* Add `make` target to run pre-commit hooks (cloudposse#286)

* Add support for "deprecated" flag/section in README (cloudposse#288)

* Better formatting of combined release notes (cloudposse#289)

* Better formatting of combined release notes

* add conditional to related section or README template (cloudposse#290)

* add conditional

* fix formatting

* update readme

* Auto Format

Co-authored-by: cloudpossebot <11232728+cloudpossebot@users.noreply.github.com>

* Add Terraform versions 0.15 and 1.x (cloudposse#293)

* Enable formatting of modules requiring TF 0.15 or TF 1. (cloudposse#294)

* Create a draft release rather than no release with `no-release` label (cloudposse#296)

* update AWS CLI (cloudposse#297)

* Make 1.x the default Terraform version (cloudposse#299)

* remove  target

* remove .github directory

Co-authored-by: David Schmidt <51931019+schmidtd@users.noreply.github.com>
Co-authored-by: Andriy Knysh <aknysh@users.noreply.github.com>
Co-authored-by: Hans Kristian Moen <hassenius@users.noreply.github.com>
Co-authored-by: Erik Osterman <erik@cloudposse.com>
Co-authored-by: Cloud Posse Bot (CI/CD) <ops@cloudposse.com>
Co-authored-by: osterman <osterman@users.noreply.github.com>
Co-authored-by: Matt Gowie <gowie.matt@gmail.com>
Co-authored-by: marcin <marcin@cloudposse.com>
Co-authored-by: Nuru <Nuru@users.noreply.github.com>
Co-authored-by: Maxim Mironenko <maxim@cloudposse.com>
Co-authored-by: Matt Calhoun <matt@cloudposse.com>
Co-authored-by: Vladimir <vladimir.fess@gmail.com>
Co-authored-by: Loren Gordon <lorengordon@users.noreply.github.com>
Co-authored-by: cloudpossebot <11232728+cloudpossebot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@osterman osterman osterman approved these changes

@jamengual jamengual Awaiting requested review from jamengual

@nitrocode nitrocode Awaiting requested review from nitrocode

Assignees
No one assigned
Labels
modules/readme
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SweetOps @osterman