Reintegrate skeleton #126

zenine07 · 2021-05-11T18:19:19Z

🗣 Description

This PR would reintegrate the cisagov/skeleton-docker skeleton into this repository.

This was done by adding the correct skeleton repository as a remote, pulling from its develop branch, and resolving any conflicts shown.

git remote add skeleton https://github.com/cisagov/skeleton-docker.git
git remote set-url --push skeleton no_push
git pull --allow-unrelated-histories skeleton develop
git status

After skeleton was merged, fixed pre-commit issues that showed up.

💭 Motivation and Context

When this project was created, it was not started using the skeleton tool This prevents the lineage GitHub Action from automatically generating PRs to ensure downstream repositories are kept up-to-date.

🧪 Testing

Automated tests pass.

🚥 Types of Changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (causes existing functionality to change)
Integrate skeleton

✅ Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

Add GitHub action caching of pre-commit hooks and pip packages.

…velop

Migrate CI system and Docker Hub organization

…rovement/actions

Add missing env variable for test

Fixes #23

…thon Set a default language for pre-commit hooks

…provement/upstream

Improvement/upstream

See: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners

Add codeowners file with team OIS maintainers.

…provement/codeowners

Improvement/codeowners

Add isort configuration file.

Add isort tool to pre-commit hooks.

A user forked cisagov/scan-target-data and created a pull request, but the required GitHub Action(s) did not run. This is presumably because the user does not have Actions enabled in his or her fork. Ideally, the required Action(s) would run in cisagov/scan-target-data when a PR to merge changes back is created. Based on my reading of this link, adding the "pull_request" event type should make this happen: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-events-for-forked-repositories

…m-forked-repos Make workflow run when a PR is opened, synchronized, or reopened

…ent/upstream-changes

zenine07 · 2021-05-12T13:08:52Z

@dav3r Are we able to disable the LGTM analysis: Python on this repo?

dav3r · 2021-05-12T14:05:15Z

@dav3r Are we able to disable the LGTM analysis: Python on this repo?

Yes, I will disable it for now. Can you please remind me to re-enable it after this PR is merged?

zenine07 · 2021-05-12T14:06:57Z

Yes, I will disable it for now. Can you please remind me to re-enable it after this PR is merged?

I can, but why does it need to be re-enabled when this isn't a Python project?

dav3r · 2021-05-12T14:07:17Z

@dav3r Are we able to disable the LGTM analysis: Python on this repo?

Yes, I will disable it for now. Can you please remind me to re-enable it after this PR is merged?

I just checked and none of the checks are required for merging yet, so don't worry about LGTM failing for now.

dav3r · 2021-05-12T14:13:58Z

Yes, I will disable it for now. Can you please remind me to re-enable it after this PR is merged?

I can, but why does it need to be re-enabled when this isn't a Python project?

In this case, LGTM will still be checking the requirements files and the Python code in the tests/ directory. It's not much, but it doesn't hurt to have it run.

zenine07 · 2021-05-12T14:16:01Z

In this case, LGTM will still be checking the requirements files and the Python code in the tests/ directory. It's not much, but it doesn't hurt to have it run.

Sounds good. I'll see if I can get it to succeed.

dav3r · 2021-05-12T14:17:56Z

In this case, LGTM will still be checking the requirements files and the Python code in the tests/ directory. It's not much, but it doesn't hurt to have it run.

Sounds good. I'll see if I can get it to succeed.

If you can't, don't sweat it too much on this PR. We have seen it behave in weird ways when it is initially integrated to a project, but tends to work after that.

jsf9k

Great work @zenine07! I requested only a couple of changes.

jsf9k · 2021-05-12T14:58:15Z

src/secrets/quote.txt

@@ -0,0 +1 @@
+There are no secrets better kept than the secrets everybody guesses.


Is this file being used here? If not then it should be removed.

@jsf9k I forget that file every time. Fixed in 26d7bb2

jsf9k · 2021-05-12T15:02:08Z

README.md

@@ -70,6 +70,6 @@ Remove containers:

 Angular app located at [localhost:4200](http://localhost:4200)

-### Run pre-commit:
+### Run pre-commit


We generally do Markdown headings ## Like this ## with trailing octothorpes. Can you make this change throughout this file?

I'm also confused as to why the linters aren't checking this file. @mcdonnnj?

We don't have anything auto-formatting on Markdown files. We would need to expand the markdownlint configuration to enforce this rule because it is on the default consistent. We should really look at adding a number of rules to the markdownlint configuration to better enforce our preferred Markdown style.

@mcdonnnj I believe it was automatically enforcing it when I ran precommit for the python-library-skeleton, but it doesn't do it in the skeleton-docker.

@zenine07 The default of consistent will only flag if you are using different styles. Since you did not merge in the skeleton's README you are consistently using the ATX style (and not the ATX closed style we prefer).

@jsf9k Made those changes in 9855810

…nd-wheel-with-pip Install/upgrade setuptools and wheel when upgrading pip

felddy and others added 30 commits November 5, 2019 15:54

Merge pull request #22 from cisagov/improvement/action_cache

10bbfdf

Add GitHub action caching of pre-commit hooks and pip packages.

Merge branch 'develop' of github.com:cisagov/skeleton-generic into de…

0bea704

…velop

Add new workflow: lint, test, and build artifact.

398e7f5

Add release workflow based on Travis.

6bdab7d

Remove Travis configuration.

5686bbe

Create a version lookup step with output.

1a174ba

Reorder jobs and pass image artifacts.

57dfd9f

Simplify artifact naming.

78348f6

Change environment variable name to be CI agnostic.

9251add

Move images from dhsncats to cisagov docker hub org.

7ed5c76

Merge pull request #12 from cisagov/improvement/actions

89cea1b

Migrate CI system and Docker Hub organization

Pass in the github release tag for testing.

e97faf6

Merge branch 'develop' of github.com:cisagov/skeleton-docker into imp…

680008d

…rovement/actions

Merge pull request #13 from cisagov/improvement/actions

5856ba9

Add missing env variable for test

Force pre-commit hooks to use python3.

7c0b30b

Fixes #23

Autoupdate pre-commit hooks.

30a16a3

Merge pull request #24 from cisagov/improvement/pre_commit_default_py…

5e26930

…thon Set a default language for pre-commit hooks

Merge branch 'develop' of github.com:cisagov/skeleton-generic into im…

65abd16

…provement/upstream

Merge pull request #14 from cisagov/improvement/upstream

c3a3643

Improvement/upstream

Add codeowners file with team OIS maintainers.

e39dc88

See: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners

Merge pull request #25 from cisagov/improvement/codeowners

3f93760

Add codeowners file with team OIS maintainers.

Update CODEOWNERS

b89eecb

Merge branch 'develop' of github.com:cisagov/skeleton-generic into im…

7b65f85

…provement/codeowners

Merge pull request #15 from cisagov/improvement/codeowners

eb0f134

Improvement/codeowners

Add seed-isort-config and isort to pre-commit hooks.

18b5d12

Add isort configuration file.

Merge pull request #28 from cisagov/improvements/pre-commit_add_isort

09afdf3

Add isort tool to pre-commit hooks.

Improve list formatting

dbd589d

Merge pull request #29 from cisagov/improvement/better-handle-prs-fro…

a8e35d0

…m-forked-repos Make workflow run when a PR is opened, synchronized, or reopened

Merge remote-tracking branch 'skeleton-generic/develop' into improvem…

e8fbc12

…ent/upstream-changes

zenine07 added the maintenance label May 11, 2021

zenine07 self-assigned this May 11, 2021

Zachary Wilson added 10 commits May 11, 2021 12:20

remove old .github files

729b89c

add codeowners

78e424e

exclude user guide from precommit

6560bdd

precommit all files

e10bab4

copy environment file for precommit and tests

e49256c

fix skeleton refs

34fae40

Bumping version from 0.0.1 to 1.0.0

96853bb

Update pytests for domain manager

3a5ebfa

disable build platforms

50826f4

add execute permissions to push_readme

a22cb37

zenine07 requested a review from dav3r May 12, 2021 13:08

zenine07 marked this pull request as ready for review May 12, 2021 14:07

zenine07 requested a review from inlguy as a code owner May 12, 2021 14:07

zenine07 requested a review from jsf9k May 12, 2021 14:07

jsf9k suggested changes May 12, 2021

View reviewed changes

Zachary Wilson added 2 commits May 12, 2021 09:59

remove unused secrets file

26d7bb2

close headers in README

9855810

zenine07 closed this Jun 9, 2021

zenine07 deleted the reintegrate_skeleton branch June 9, 2021 12:36

zenine07 restored the reintegrate_skeleton branch June 9, 2021 12:37

cisagovbot pushed a commit that referenced this pull request Jul 14, 2023

Merge pull request #126 from cisagov/improvement/install-setuptools-a…

7250368

…nd-wheel-with-pip Install/upgrade setuptools and wheel when upgrading pip

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reintegrate skeleton #126

Reintegrate skeleton #126

zenine07 commented May 11, 2021 •

edited

Loading

zenine07 commented May 12, 2021

dav3r commented May 12, 2021

zenine07 commented May 12, 2021

dav3r commented May 12, 2021

dav3r commented May 12, 2021

zenine07 commented May 12, 2021

dav3r commented May 12, 2021

jsf9k left a comment

jsf9k May 12, 2021

zenine07 May 12, 2021

jsf9k May 12, 2021

mcdonnnj May 12, 2021 •

edited

Loading

zenine07 May 12, 2021

mcdonnnj May 12, 2021

zenine07 May 12, 2021

		@@ -0,0 +1 @@
		There are no secrets better kept than the secrets everybody guesses.

Reintegrate skeleton #126

Reintegrate skeleton #126

Conversation

zenine07 commented May 11, 2021 • edited Loading

🗣 Description

💭 Motivation and Context

🧪 Testing

🚥 Types of Changes

✅ Checklist

zenine07 commented May 12, 2021

dav3r commented May 12, 2021

zenine07 commented May 12, 2021

dav3r commented May 12, 2021

dav3r commented May 12, 2021

zenine07 commented May 12, 2021

dav3r commented May 12, 2021

jsf9k left a comment

Choose a reason for hiding this comment

jsf9k May 12, 2021

Choose a reason for hiding this comment

zenine07 May 12, 2021

Choose a reason for hiding this comment

jsf9k May 12, 2021

Choose a reason for hiding this comment

mcdonnnj May 12, 2021 • edited Loading

Choose a reason for hiding this comment

zenine07 May 12, 2021

Choose a reason for hiding this comment

mcdonnnj May 12, 2021

Choose a reason for hiding this comment

zenine07 May 12, 2021

Choose a reason for hiding this comment

zenine07 commented May 11, 2021 •

edited

Loading

mcdonnnj May 12, 2021 •

edited

Loading