Skip to content

Commit 9dd0eaa

Browse files
authored
Merge pull request #34 from hackforla/cb/making-updates
making updates to revert back to cloning the repo due to conflicts
2 parents 0449d78 + 4a50da2 commit 9dd0eaa

2 files changed

Lines changed: 11 additions & 86 deletions

File tree

.github/ISSUE_TEMPLATE/pre-work-template-devops-security.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,8 @@ As a new member on the HfLA devops-security team, fill in the following fields a
3737
- [ ] Complete the instruction in [AWS Documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-authentication-short-term.html) to setup the AWS CLI.
3838
- [ ] Read follow the instructions in [Creating a backend state](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#creating-backend-state).
3939
- [ ] Install Terraform locally by following the instructions of the installation guide mentioned in [Installing Terraform](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#installing-terraform)
40-
- [ ] Install Terraform Docs locally by following the instructions of the installation guide mentiond in [Installing Terrafrom docs](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#installing-terraform-docs)
41-
- [ ] Complete the instructions in [Fork the repository](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#fork-the-repository) and [Clone (Create) a copy on your computer](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#clone-create-a-copy-on-your-computer)
42-
- [ ] In your code editor navigate to `terraform` directory.
43-
- [ ] Execute the command `terraform plan` this will output a plan replicating the same IAM resources as the devops security account.
44-
- [ ] Then execute the command `terraform apply` this will create all of the resources that are currently managed by Devops Security. All of the resources created here incur zero cost except for the Dynamo DB installation, which should remain in the free tier.
45-
- [ ] ** If you have cost concerns, Run a Terraform Destroy to take down all of the resources you created (don't worry, you can recreate them just as quickly). **
40+
- [ ] Install Terraform Docs locally by following the instructions of the installation guide mentioned in [Installing Terraform docs](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#installing-terraform-docs)
41+
- [ ] Complete the instructions in [Clone the repository](https://github.com/hackforla/devops-security/blob/main/CONTRIBUTING.md#clone-the-repository)
4642
- [ ] Submit a [new request](https://github.com/hackforla/devops-security/issues/new?assignees=&labels=enhancement&projects=&template=request-aws-iam-resources.yml) to create new AWS user account and then self-assign this issue.
4743
- [ ] Create a new branch from main by executing the command
4844

@@ -66,9 +62,13 @@ As a new member on the HfLA devops-security team, fill in the following fields a
6662
}
6763
6864
```
69-
- [ ] Stage changes in git with
65+
- [ ] In your code editor navigate to `terraform` directory. `cd terraform`
66+
- [ ] Execute the command `terraform init` to initialize terraform in the directory. Address any failures that arise (if any).
67+
- [ ] Execute the command `terraform plan` this will output a plan replicating the same IAM resources as the devops security account. Address any failures that arise (if any).
68+
- [ ] Then execute the command `terraform apply` this will create all of the resources that are currently managed by Devops Security. All of the resources created here incur zero cost except for the Dynamo DB installation, which should remain in the free tier.
69+
- [ ] ** If you have cost concerns, Run a Terraform Destroy to take down all of the resources you created (don't worry, you can recreate them just as quickly). **
70+
- [ ] Once you have tested your changes, stage them in git with
7071
- [ ] `git status` command.
7172
- [ ] then `git add path/to/file` (you can copy from above output for the file path).
7273
- [ ] Commit the changes by executing `git commit -m "briefly describing the changes"`.
7374
- [ ] Push the changes with `git push --set-upstream origin name-of-branch`
74-

CONTRIBUTING.md

Lines changed: 3 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,7 @@ Below are guidelines for contributing to the devops-security repository hosted o
2525
- [**Installing Terraform**](#installing-terraform)
2626
- [**Creating Backend State**](#creating-backend-state)
2727
- [**Installing Terraform docs**](#installing-terraform-docs)
28-
- [**Fork the repository**](#fork-the-repository)
2928
- [**Clone (Create) a copy on your computer**](#clone-create-a-copy-on-your-computer)
30-
- [**Verify `origin` remote url**](#verify-origin-remote-url)
31-
- [**What if you accidentally cloned using the repository URL from the HackForLA Github (instead of the fork on your Github)?**](#what-if-you-accidentally-cloned-using-the-repository-url-from-the-hackforla-github-instead-of-the-fork-on-your-github)
32-
- [**i. Reset `origin` remote url**](#i-reset-origin-remote-url)
33-
- [**ii. Add an `upstream` remote**](#ii-add-an-upstream-remote)
3429
- [**Create a new branch where you will work on your issue**](#create-a-new-branch-where-you-will-work-on-your-issue)
3530
- [**Terraform Setup and Execution Instructions**](#terraform-setup-and-execution-instructions)
3631
- [**Submitting changes via git and opening a PR**](#submitting-changes-via-git-and-opening-a-pr)
@@ -165,29 +160,7 @@ Follow the Terraform docs [installation guide](https://terraform-docs.io/user-gu
165160
<sub>[Back to Table of Contents](#table-of-contents)</sub>
166161
***
167162

168-
## **Fork the repository**
169-
170-
Fork the hackforla/devops-security repository by clicking <a href="https://github.com/hackforla/devops-security/fork"> <button> <img src="https://user-images.githubusercontent.com/17777237/54873012-40fa5b00-4dd6-11e9-98e0-cc436426c720.png" width="8px"> Fork</button></a>
171-
. A fork is a copy of the repository that will be placed on your GitHub account.
172-
173-
<details>
174-
<summary><strong>Click here</strong> to see a visual example of the `fork` button within the devops-security repo</summary>
175-
<p><strong>First, you find the `fork` button on the top right hand side of the [Hack for LA devops-security repo](https://github.com/hackforla/devops-security)</strong></h4>
176-
<img src="https://github.com/freaky4wrld/devops-security/assets/134206855/ff3bbadb-5798-4f37-ad3f-b9f699595381" />
177-
<p><strong>Next, a modal may open and request where you want to fork this devops-security repo. Please click on your avatar or your GitHub username</strong></p>
178-
<img src="https://github.com/freaky4wrld/devops-security/assets/134206855/db7a0ca9-3dee-429e-a5eb-115248a52884" />
179-
</details><br>
180-
181-
**Note:** It should create a URL that looks like the following -> `https://github.com/<your_GitHub_user_name>/devops-security`.
182-
183-
**For example** -> `https://github.com/octocat/devops-security`.
184-
185-
**Be Aware:** What you have created is a forked copy in a remote version on GitHub. It is not yet on your local machine.
186-
187-
<sub>[Back to Table of Contents](#table-of-contents)</sub>
188-
***
189-
190-
## **Clone (Create) a copy on your computer**
163+
## **Clone the repository**
191164

192165
Create a new folder in your computer that will contain `hackforla` projects.
193166

@@ -202,12 +175,7 @@ cd hackforla
202175
and run the following commands:
203176

204177
```bash
205-
git clone https://github.com/<your_GitHub_user_name>/devops-security.git
206-
```
207-
208-
For example if your GitHub username was `octocat`:
209-
```bash
210-
git clone https://github.com/octocat/devops-security.git
178+
git clone https://github.com/hackforla/devops-security.git
211179
```
212180

213181
You should now have a new folder in your `hackforla` folder called `devops-security`. Verify this by changing into the new directory:
@@ -216,49 +184,6 @@ You should now have a new folder in your `hackforla` folder called `devops-secur
216184
cd devops-security
217185
```
218186

219-
#### **Verify `origin` remote url**
220-
221-
Verify that your local cloned repository is pointing to the correct `origin` URL (that is, the forked repo on your own Github account):
222-
```bash
223-
git remote -v
224-
```
225-
You should see `fetch` and `push` URLs with links to your forked repository under your account (i.e. `https://github.com/<your_GitHub_user_name>/devops-security.git`). You are all set to make working changes to the devops-security on your local machine.
226-
227-
However, we still need a way to keep our local repo up to date with the deployed devops-security. To do so, you must add an upstream remote to incorporate changes made while you are working on your local repo. Run the following to add an upstream remote URL & update your local repo with recent changes to the `hackforla` version:
228-
229-
```bash
230-
git remote add upstream https://github.com/hackforla/devops-security.git
231-
git fetch upstream
232-
```
233-
234-
After adding the upstream remote, you should now see it if you again run `git remote -v` :
235-
```bash
236-
origin https://github.com/<your_GitHub_user_name>/devops-security.git (fetch)
237-
origin https://github.com/<your_GitHub_user_name>/devops-security.git (push)
238-
upstream https://github.com/hackforla/devops-security.git (fetch)
239-
upstream https://github.com/hackforla/devops-security.git (push)
240-
```
241-
#### **What if you accidentally cloned using the repository URL from the HackForLA Github (instead of the fork on your Github)?**
242-
243-
##### **i. Reset `origin` remote url**
244-
245-
Set your forked repo on your Github as an `origin` remote:
246-
```bash
247-
git remote set-url origin https://github.com/<your_GitHub_user_name>/devops-security.git
248-
```
249-
250-
For example if your GitHub username was `octocat`:
251-
```bash
252-
git remote set-url origin https://github.com/octocat/devops-security.git
253-
```
254-
255-
##### **ii. Add an `upstream` remote**
256-
257-
Add another remote called `upstream` that points to the `hackforla` version of the repository. This will allow you to incorporate changes later:
258-
```bash
259-
git remote add upstream https://github.com/hackforla/devops-security.git
260-
```
261-
262187
<sub>[Back to Table of Contents](#table-of-contents)</sub>
263188
***
264189

@@ -322,7 +247,7 @@ terraform plan
322247
- Push changes to the remote repository, replace the `branch_name` with the name of the branch you are working on
323248

324249
```bash
325-
git push --set-upstream origin main branch_name
250+
git push --set-upstream origin branch_name
326251
```
327252
- Lastly open a PR to merge your changes into the `main` branch.
328253

0 commit comments

Comments
 (0)