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.

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

docs(dev): Add initial high-level document for CI #36

Closed
wants to merge 106 commits into from

Conversation

@cradkowski
Copy link
Contributor

commented Aug 4, 2019

I added the initial high-level description of what CI is and included basic instructions for enabling this in GitHub and GitLab (eventually will further link to more specific documents for each platform later).
Any edits or suggestions are welcome, particularly for my definition of what Continuous Integration is.

Signed-off-by: Chris Radkowski cradkowski@worcester.edu

StoneyJackson and others added some commits Feb 28, 2019

Update README.md
Correct plural of Friday.
Add AUTHORS and generate-authors.py
- bin/generate-authros.py generate an author list based on `git log`.
- AUTHORS - List of authors.
Rename LICENSE_FOR_CONTENT
Using underscores instead of hyphens makes it easier to type
an all uppercase name, and is consistent with naming conventention
for CODE_OF_CONDUCT.
Add Governance.md
- Defines the Coordinating Committee
- Defines Trustees
- Lists current Trustees
- Defines Shop managers
- Lists current Shop Managers
- Explains how decissions are made
- Provides links to minutes of the Coordinating Committee

Closes #1
Add Communication.md
- Defines communication channels and how they should be used.

Closes #29
Add ShopManagers.md
- Describes how to become a shop manager.
- Describes how to contribute as a shop.

Closes #6
Add ContributingAsAnIndividual.md
Describes how to contribute as an individual.
Integrate "Using the Issue Tracker"
- Describes how to use the issue tracker.
Merge pull request #31 from LibreFoodPantry/issue-25-doc-licenses
Add CopyrightAndLicensing.md policies

StoneyJackson and others added some commits Aug 3, 2019

fix(contributing): Fix wording and broken links
Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
refactor(contributing): Improve wording and style of shop-setup
Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
fix(contributing): Restore Vision and Mission to CONTRIBUTING.md
Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
Merge pull request #29 from LibreFoodPantry/contributing
docs(dev): Tighten up CONTRIBUTING and its linkage
docs(dev): Add instructions for automating DCO checks
Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
refactor(dev)!: Move copyright-notices/ into docs/dev/
BREAKING CHANGE: Moving copyright-notices/ into docs/dev/
Any files that depend on the old location will not work.

The copyright-notices are only needed by developers,
and they don't really need to be at the top level.
So we're movign copyright-notices/ into docs/dev/
to help declutter the root directory.

Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
Merge pull request #31 from LibreFoodPantry/bug-template
feat(templates): Add bug label to bug report template
Merge pull request #32 from LibreFoodPantry/enhancement-template
feat(templates): Add enhancement label to feature request template
Merge pull request #34 from LibreFoodPantry/move-copyright-notices
refactor(dev)!: Move copyright-notices/ into docs/dev/
feat(docs(dev)): Add screenshot of enabling DCO bot in GitHub
Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
fix(docs(dev)): Fix link from CONTRIBUTING to automating-dco-checks
Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
docs(dev): Add instructions for automating DCO checks in GitLab
Signed-off-by: Chris Radkowski <cradkowski@worcester.edu>
fix(docs(dev)): Updated GitLab section to indicate this doesn't work …
…on GitLab Free edition

Signed-off-by: Chris Radkowski <cradkowski@worcester.edu>
docs(dev): Add initial high-level document for CI
Signed-off-by: Chris Radkowski <cradkowski@worcester.edu>

@cradkowski cradkowski requested review from kwurst and StoneyJackson Aug 4, 2019

StoneyJackson and others added some commits Aug 5, 2019

feat(docs(dev)): Add more complete DCO check docs for GitHub
Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
Merge pull request #33 from LibreFoodPantry/automating-dco-checks
docs(dev): Add instructions for automating DCO checks
@StoneyJackson
Copy link
Collaborator

left a comment

@cradkowski Great start! I'm going to make some revisions and add CD. I'll ask you to review when I'm done.

StoneyJackson added some commits Aug 9, 2019

docs(dev): more thorough documentation for CI/CD
Signed-off-by: Stoney Jackson <dr.stoney@gmail.com>
@StoneyJackson

This comment has been minimized.

Copy link
Collaborator

commented Aug 9, 2019

@cradkowski hmm... I can't add you as a reviewer. Consider yourself added. If you are good with it, I'll merge. If not, we'll make more changes :)

@cradkowski
Copy link
Contributor Author

left a comment

I approve these changes.

@@ -0,0 +1,63 @@
# Continuous Integration and Deployment/Delivery

For a more in-depth look at CI/CD see [GitHub's video about CI](https://youtu.be/xSv_m3KhUO8)

This comment has been minimized.

Copy link
@cradkowski

cradkowski Aug 9, 2019

Author Contributor

Maybe change the link name since the video is about CI and CD.

@StoneyJackson StoneyJackson deleted the document-ci branch Aug 15, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
You can’t perform that action at this time.