Skip to content

Commit

Permalink
docs: update name refs (#368)
Browse files Browse the repository at this point in the history
* update name in security

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* update name in readme

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

* update name in workflows

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>

---------

Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>
  • Loading branch information
rdhar authored Dec 19, 2024
1 parent d8bebcf commit 734769e
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/examples/pr_merge_matrix.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
uses: opentofu/setup-opentofu@v1

- name: Provision TF
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: ${{ github.event_name == 'merge_group' && 'apply' || 'plan' }}
arg-lock: ${{ github.event_name == 'merge_group' }}
Expand Down
2 changes: 1 addition & 1 deletion .github/examples/pr_push_auth.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
uses: hashicorp/setup-terraform@v3

- name: Provision TF
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: ${{ github.event_name == 'push' && 'apply' || 'plan' }}
arg-lock: ${{ github.event_name == 'push' }}
Expand Down
4 changes: 2 additions & 2 deletions .github/examples/pr_push_lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Init TF
id: tf
if: ${{ github.event_name == 'pull_request' }}
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: init
arg-lock: false
Expand Down Expand Up @@ -76,7 +76,7 @@ jobs:
exit 1
- name: Provision TF
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: ${{ github.event_name == 'push' && 'apply' || 'plan' }}
arg-lock: ${{ github.event_name == 'push' }}
Expand Down
6 changes: 3 additions & 3 deletions .github/examples/pr_push_stages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
uses: hashicorp/setup-terraform@v3

- name: Plan TF
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: plan
working-directory: path/to/directory
Expand All @@ -44,7 +44,7 @@ jobs:

- name: Init TF
id: tf
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: init
working-directory: path/to/directory
Expand Down Expand Up @@ -90,7 +90,7 @@ jobs:
uses: hashicorp/setup-terraform@v3

- name: Apply TF
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: apply
working-directory: path/to/directory
Expand Down
2 changes: 1 addition & 1 deletion .github/examples/pr_self_hosted.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
uses: opentofu/setup-opentofu@v1

- name: Provision TF
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: ${{ github.event.pull_request.merged && 'apply' || 'plan' }}
arg-lock: ${{ github.event.pull_request.merged }}
Expand Down
2 changes: 1 addition & 1 deletion .github/examples/schedule_refresh.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:

- name: Plan TF
id: provision
uses: devsectop/tf-via-pr@v12
uses: op5dev/tf-via-pr@v12
with:
command: plan
arg-lock: false
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tf_sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
with:
aws-region: ${{ env.AWS_REGION }}
role-to-assume: ${{ secrets.AWS_ROLE }}
role-session-name: devsectop-tf-via-pr-${{ github.run_id }}-${{ github.run_attempt}}
role-session-name: tf-via-pr-${{ github.run_id }}-${{ github.run_attempt}}

- name: Setup TF
uses: opentofu/setup-opentofu@12f4debbf681675350b6cd1f0ff8ecfbda62027b # v1.0.4
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[![Terraform Compatible](https://img.shields.io/badge/Terraform-Compatible-844FBA?logo=terraform&logoColor=white)](https://github.com/hashicorp/setup-terraform "Terraform Compatible.")
[![OpenTofu Compatible](https://img.shields.io/badge/OpenTofu-Compatible-FFDA18?logo=opentofu&logoColor=white)](https://github.com/opentofu/setup-opentofu "OpenTofu Compatible.")
*
[![GitHub license](https://img.shields.io/github/license/devsectop/tf-via-pr?logo=apache&label=License)](LICENSE.txt "Apache License 2.0.")
[![GitHub release tag](https://img.shields.io/github/v/release/devsectop/tf-via-pr?logo=semanticrelease&label=Release)](https://github.com/devsectop/tf-via-pr/releases "View all releases.")
[![GitHub license](https://img.shields.io/github/license/op5dev/tf-via-pr?logo=apache&label=License)](LICENSE.txt "Apache License 2.0.")
[![GitHub release tag](https://img.shields.io/github/v/release/op5dev/tf-via-pr?logo=semanticrelease&label=Release)](https://github.com/op5dev/tf-via-pr/releases "View all releases.")
*
[![GitHub repository stargazers](https://img.shields.io/github/stars/devsectop/tf-via-pr)](https://github.com/devsectop/tf-via-pr "Become a stargazer.")
[![GitHub repository stargazers](https://img.shields.io/github/stars/op5dev/tf-via-pr)](https://github.com/op5dev/tf-via-pr "Become a stargazer.")

# Terraform/OpenTofu via Pull Request (TF-via-PR)

Expand Down Expand Up @@ -36,7 +36,7 @@

### View: [Usage Examples](#usage) · [In/Output Parameters](#parameters) · [Security](#security) · [Changelog](#changelog) · [License](#license)

[![PR comment of plan output with "Diff of changes" section expanded.](/.github/assets/comment.png)](https://raw.githubusercontent.com/devsectop/tf-via-pr/refs/heads/main/.github/assets/comment.png "View full-size image.")
[![PR comment of plan output with "Diff of changes" section expanded.](/.github/assets/comment.png)](https://raw.githubusercontent.com/op5dev/tf-via-pr/refs/heads/main/.github/assets/comment.png "View full-size image.")
</br></br>

## Usage
Expand All @@ -62,7 +62,7 @@ jobs:
steps:
- uses: actions/checkout@4
- uses: hashicorp/setup-terraform@v3
- uses: devsectop/tf-via-pr@v12
- uses: op5dev/tf-via-pr@v12
with:
# Run plan by default, or apply with lock on merge.
command: ${{ github.event_name == 'push' && 'apply' || 'plan' }}
Expand Down Expand Up @@ -138,7 +138,7 @@ unzip <tf.plan>

For each workflow run, a matrix-friendly job summary with logs is added as a fallback to the PR comment. Below this, you'll find a list of plan file artifacts generated during runtime.</br>

[![Workflow job summary with plan file artifact.](/.github/assets/workflow.png)](https://raw.githubusercontent.com/devsectop/tf-via-pr/refs/heads/main/.github/assets/workflow.png "View full-size image.")
[![Workflow job summary with plan file artifact.](/.github/assets/workflow.png)](https://raw.githubusercontent.com/op5dev/tf-via-pr/refs/heads/main/.github/assets/workflow.png "View full-size image.")
</br></br>

## Parameters
Expand All @@ -163,7 +163,7 @@ For each workflow run, a matrix-friendly job summary with logs is added as a fal

The default behavior of `comment-pr` is to update the existing PR comment with the latest plan output, making it easy to track changes over time through the comment's revision history.</br>

[![PR comment revision history comparing plan and apply outputs.](/.github/assets/revisions.png)](https://raw.githubusercontent.com/devsectop/tf-via-pr/refs/heads/main/.github/assets/revisions.png "View full-size image.")
[![PR comment revision history comparing plan and apply outputs.](/.github/assets/revisions.png)](https://raw.githubusercontent.com/op5dev/tf-via-pr/refs/heads/main/.github/assets/revisions.png "View full-size image.")
</br></br>

### Inputs - Arguments
Expand Down Expand Up @@ -247,16 +247,16 @@ View [security policy and reporting instructions](SECURITY.md).

## Changelog

View [all notable changes](https://github.com/devsectop/tf-via-pr/releases "Releases.") to this project in [Keep a Changelog](https://keepachangelog.com "Keep a Changelog.") format, which adheres to [Semantic Versioning](https://semver.org "Semantic Versioning.").
View [all notable changes](https://github.com/op5dev/tf-via-pr/releases "Releases.") to this project in [Keep a Changelog](https://keepachangelog.com "Keep a Changelog.") format, which adheres to [Semantic Versioning](https://semver.org "Semantic Versioning.").

> [!TIP]
>
> All forms of **contribution are very welcome** and deeply appreciated for fostering open-source projects.
>
> - [Create a PR](https://github.com/devsectop/tf-via-pr/pulls "Create a pull request.") to contribute changes you'd like to see.
> - [Raise an issue](https://github.com/devsectop/tf-via-pr/issues "Raise an issue.") to propose changes or report unexpected behavior.
> - [Open a discussion](https://github.com/devsectop/tf-via-pr/discussions "Open a discussion.") to discuss broader topics or questions.
> - [Become a stargazer](https://github.com/devsectop/tf-via-pr/stargazers "Become a stargazer.") if you find this project useful.
> - [Create a PR](https://github.com/op5dev/tf-via-pr/pulls "Create a pull request.") to contribute changes you'd like to see.
> - [Raise an issue](https://github.com/op5dev/tf-via-pr/issues "Raise an issue.") to propose changes or report unexpected behavior.
> - [Open a discussion](https://github.com/op5dev/tf-via-pr/discussions "Open a discussion.") to discuss broader topics or questions.
> - [Become a stargazer](https://github.com/op5dev/tf-via-pr/stargazers "Become a stargazer.") if you find this project useful.
</br>

### To-Do
Expand All @@ -268,5 +268,5 @@ View [all notable changes](https://github.com/devsectop/tf-via-pr/releases "Rele
## License

- This project is licensed under the permissive [Apache License 2.0](LICENSE.txt "Apache License 2.0.").
- All works herein are my own, shared of my own volition, and [contributors](https://github.com/devsectop/tf-via-pr/graphs/contributors "Contributors.").
- All works herein are my own, shared of my own volition, and [contributors](https://github.com/op5dev/tf-via-pr/graphs/contributors "Contributors.").
- Copyright 2022-2024 [Rishav Dhar](https://github.com/rdhar "Rishav Dhar's GitHub profile.") — All wrongs reserved.
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Integrating security in your CI/CD pipeline is critical to practicing DevSecOps.

## Reporting a Vulnerability

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <security@devsec.top> or reported via [Security Advisory](https://github.com/devsectop/tf-via-pr/security/advisories/new "Create a new security advisory.").
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <contact@OP5.top> or reported via [Security Advisory](https://github.com/op5dev/tf-via-pr/security/advisories/new "Create a new security advisory.").

0 comments on commit 734769e

Please sign in to comment.