Update Skeleton Instructions for Development Guide Project Setup by dv4harr10 · Pull Request #97 · cisagov/development-guide

dv4harr10 · 2024-02-13T19:51:50Z

🗣 Description

This PR will update the Documentation Guide Project Setup markdown files instructions to create new skeleton repositories or skeletonize existing repositories.

💭 Motivation and context

These updates are required for uniformity of the cisagov skeleton updates to create and update repositories and to advise on the latest skeletonize tools used.

✅ Pre-approval checklist

This PR has an informative and human-readable title.
Changes are limited to a single goal - eschew scope creep!
All relevant type-of-change labels have been added.
I have read the CONTRIBUTING document.
These code changes follow cisagov code standards.
All relevant repo and/or project documentation has been updated
to reflect the changes in this PR.
All new and existing tests pass.

✅ Pre-merge checklist

Revert dependencies to default branches.
Finalize version.

✅ Post-merge checklist

Create a release.

project_setup/README.md

project_setup/skeleton-list.md

project_setup/skeletonize-existing-repository.md

dav3r

Approved, but with one small item noted.

project_setup/skeletonize-existing-repository.md

jsf9k · 2024-02-16T16:32:07Z

Let's get @mcdonnnj's review before merging.

mcdonnnj · 2024-02-20T08:56:14Z

project_setup/README.md

-helper tool included in the [`scripts`](scripts) directory can quickly setup
-a new local repository. Once you've cloned and configured the repository
-to your local machine, it can be published to a repository created on GitHub.
+The [`gh-skeleton`](https://github.com/cisagov/gh-skeleton) GitHub CLI


It looks like we link out to the gh-skeleton repository in multiple places. Please switch this to a reference-style link and update all uses of "gh-skeleton" to both use this link when appropriate and be formatted consistently.

Hi @mcdonnnj , update to reference-style link. Addressed at 077cfbf

mcdonnnj · 2024-02-20T08:56:29Z

project_setup/README.md


 - [Adding a skeleton configuration to an existing repository](#adding-a-skeleton-configuration-to-an-existing-repository)
- [Using the skeleton tool to start a new repository 💀🛠](#using-the-skeleton-tool-to-start-a-new-repository-)
+- [Using the gh-skeleton `gh` extension to start a new repository 💀🛠](#using-the-gh-skeleton-gh-extension-to-start-a-new-repository-)


The emoji no longer make sense.

Suggested change

- [Using the gh-skeleton `gh` extension to start a new repository 💀🛠](#using-the-gh-skeleton-gh-extension-to-start-a-new-repository-)

- [Using the gh-skeleton `gh` extension to start a new repository](#using-the-gh-skeleton-gh-extension-to-start-a-new-repository-)

Hi @mcdonnnj , removed skeleton tool emoji. Addressed at ffbea4a
ffbea4a

mcdonnnj · 2024-02-20T09:01:44Z

project_setup/README.md

 ```bash
-./skeleton list
+gh skeleton list
 ```

 ```console


Please combine these codeblocks and ensure the sample output aligns with the output of the extension. Please also update the lead-in formatting like so:

```console $ gh skeleton list

Hi @mcdonnnj , updated, replace text at line 54 to 58 Readme.md. Addressed at
ffbea4a

mcdonnnj · 2024-02-20T09:02:53Z

project_setup/README.md


 ```console
-./skeleton clone [options] <parent-repo-name> <new-repo-name>
+gh skeleton clone [options] <parent-repo-name> <new-repo-name>


Suggested change

gh skeleton clone [options] <parent-repo-name> <new-repo-name>

$ gh skeleton clone [options] <parent-repo-name> <new-repo-name>

Hi @mcdonnnj , I received 2 linter failed errors for adding the dollar sign prompt, it complains that expected output is required. I worked with Michael on this solution to add the following:

$ gh skeleton clone [options] <parent-repo-name> <new-repo-name> # Expected output: # Cloning into 'new-repo-name' .

Alternatively we may need to omit the dollar sign prompt. What do you suggest?

Hi @mcdonnnj , the change above satisfied the linter. Addressed at 077cfbf

mcdonnnj · 2024-02-20T09:03:13Z

project_setup/README.md

 For example, to create a project based on `skeleton-ansible-role` named
 `ansible-role-quantum-rng` in your local `~/projects` directory:

 ```bash


Suggested change

```bash

```console

Hi @mcdonnnj , updated text line 100. Addressed at
ffbea4a

mcdonnnj · 2024-02-20T09:13:14Z

project_setup/skeletonize-existing-repository.md

@@ -1,12 +1,14 @@
 # Skeletonize an Existing Repository #

 Skeletonizing a repository standardizes our development setup and environment,


Suggested change

Skeletonizing a repository standardizes our development setup and environment,

Skeletonizing a repository standardizes our development setup and environment

Hi @mcdonnnj , removed comma at end. of line. Addressed at
ffbea4a

mcdonnnj · 2024-02-20T09:13:44Z

project_setup/skeletonize-existing-repository.md

-to keep the repository updated and standardized.
+and enables our [Lineage GitHub Action](https://github.com/cisagov/action-lineage/)
+to keep the repository updated and standardized. The purpose of the
+instructions here is to describe how to skeletonize an existing non-skeletonized


Suggested change

instructions here is to describe how to skeletonize an existing non-skeletonized

instructions here are to describe how to skeletonize an existing non-skeletonized

Hi @mcdonnnj , grammar text update. Addressed at
ffbea4a

mcdonnnj · 2024-02-20T09:17:28Z

project_setup/skeletonize-existing-repository.md

-non-skeletonized repository
+1. [Add the skeleton as a remote](#add-the-skeleton-as-a-remote) to the
+existing non-skeletonized repository
 1. Pull with `--allow-unrelated-histories`


Suggested change

1. Pull with `--allow-unrelated-histories`

1. Pull with `git pull --allow-unrelated-histories skeleton-parent`

Hi @mcdonnnj , suggested working update for command. Addressed at
ffbea4a

mcdonnnj · 2024-02-20T09:19:00Z

project_setup/skeletonize-existing-repository.md

+First, decide which of the available skeletons best fits your
+existing non-skeletonized repository. To see a list of available
+skeletons, use the `gh skeleton list` command or see
 the [list of skeletons](skeleton-list.md).


Are we able to use a link fragment here to link to the appropriate section?

Hi @mcdonnnj , Can you please elaborate regarding the fragment link required ? From my understanding the 'gh skeleton list' command is to be run at the command line. And the skeleton-list link goes to skeleton-list.md document.

Hi @mcdonnnj , update to fragment link. Addressed at 077cfbf

project_setup/skeletonize-existing-repository.md

project_setup/README.md

This commit will remove out-dated skeleton tool instructions. Previously the documentation was using a legacy skeleton tool. Now the instructions will reflect using the gh CLI skeleton tool extension. Links have been updated along with steps to make a repository from a skeleton.

Updated naming of gh tool to be more accurate verbiage from gh CLI extension to gh skeleton. Updated link to skeleton AWS lambda python which was linked to archived skeleton AWS lambda.

Update naming convention to GitHub CLI 'gh' Extension Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

This commit updates Development guide Readme and Skeletonize existing repository according to requested changes for wording, grammar, replacing text and delete emoji.

This commit updates Development guide links using a reference style for gh-skeleton links in the Readme file and directly links to the skeleton list for skeletonize existing repository file.

This commit fixes some fragment links that were not working.

Updates to add reference links, fragment link, and text changes to skeleton list file.

command promt dollar sign text change

Adding reference link to maintain consistency of link references globally for gh-skeleton extension tool.

Referenced skeleton list required update.

add back whitespace to reflect what the user should expect to see in terminal output.

Redo changes to formatting to reflect what the user should expect to see in terminal output.

dv4harr10 added the documentation This issue or pull request improves or adds to documentation label Feb 13, 2024

dv4harr10 self-assigned this Feb 13, 2024

dv4harr10 requested review from dav3r, felddy, jasonodoom, jsf9k and mcdonnnj as code owners February 13, 2024 19:51

jsf9k requested changes Feb 14, 2024

View reviewed changes

jsf9k approved these changes Feb 15, 2024

View reviewed changes

dav3r approved these changes Feb 15, 2024

View reviewed changes

dav3r reviewed Feb 15, 2024

View reviewed changes

project_setup/skeletonize-existing-repository.md Outdated Show resolved Hide resolved

michaelsaki linked an issue Feb 16, 2024 that may be closed by this pull request

Update instructions for project setup #88

Open

mcdonnnj requested changes Feb 28, 2024

View reviewed changes

dav3r reviewed Mar 4, 2024

View reviewed changes

project_setup/README.md Outdated Show resolved Hide resolved

dv4harr10 and others added 15 commits March 7, 2024 16:28

Add description change for gh skeleton tool

950785e

Updated naming of gh tool to be more accurate verbiage from gh CLI extension to gh skeleton. Updated link to skeleton AWS lambda python which was linked to archived skeleton AWS lambda.

Apply suggestions from code review

9c69ff6

Update naming convention to GitHub CLI 'gh' Extension Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Link Correction

5303b7a

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Language verbiage corrections

6a5c4cb

Co-authored-by: Shane Frasier <jeremy.frasier@gwe.cisa.dhs.gov>

Reformat to placate Markdown linter

9e86d9f

Fix text and link for merge conflict

bb058e7

Suggested text changes from code review

f5425f3

This commit updates Development guide Readme and Skeletonize existing repository according to requested changes for wording, grammar, replacing text and delete emoji.

Update links per code review

90ab104

This commit updates Development guide links using a reference style for gh-skeleton links in the Readme file and directly links to the skeleton list for skeletonize existing repository file.

Update to Readme fragment links

9df575b

This commit fixes some fragment links that were not working.

Add suggested link and grammar changes

4d326de

Updates to add reference links, fragment link, and text changes to skeleton list file.

Add text change to ReadMe

1abec20

command promt dollar sign text change

Add reference link to skeleton list file

27e8e85

Adding reference link to maintain consistency of link references globally for gh-skeleton extension tool.

Update output for gh skeleton list command

6f8b109

Referenced skeleton list required update.

Update output for gh skeleton list command #2

868a2e0

add back whitespace to reflect what the user should expect to see in terminal output.

Update output for gh skeleton list command #3

201b4c7

Redo changes to formatting to reflect what the user should expect to see in terminal output.

jsf9k force-pushed the documentation/update-skeleton-instructions branch from 8513d28 to 201b4c7 Compare March 7, 2024 21:28

	- [Using the gh-skeleton `gh` extension to start a new repository 💀🛠](#using-the-gh-skeleton-gh-extension-to-start-a-new-repository-)
	- [Using the gh-skeleton `gh` extension to start a new repository](#using-the-gh-skeleton-gh-extension-to-start-a-new-repository-)

	gh skeleton clone [options] <parent-repo-name> <new-repo-name>
	$ gh skeleton clone [options] <parent-repo-name> <new-repo-name>

		@@ -1,12 +1,14 @@
		# Skeletonize an Existing Repository #

		Skeletonizing a repository standardizes our development setup and environment,

	instructions here is to describe how to skeletonize an existing non-skeletonized
	instructions here are to describe how to skeletonize an existing non-skeletonized

	1. Pull with `--allow-unrelated-histories`
	1. Pull with `git pull --allow-unrelated-histories skeleton-parent`

Conversation

dv4harr10 commented Feb 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🗣 Description

💭 Motivation and context

✅ Pre-approval checklist

✅ Pre-merge checklist

✅ Post-merge checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dav3r left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jsf9k commented Feb 16, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dv4harr10 Feb 28, 2024 • edited by michaelsaki Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dv4harr10 commented Feb 13, 2024 •

edited

Loading

dv4harr10 Feb 28, 2024 •

edited by michaelsaki

Loading