-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #73 from Clever/refactor-provider
Create a Provider (Github/Gitlab) during init and pass it on to other steps
- Loading branch information
Showing
30 changed files
with
952 additions
and
430 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,8 @@ | ||
## JIRA | ||
[Link to JIRA](insert url) | ||
_If there was a JIRA ticket associated with this changes, please link it here._ | ||
|
||
## Overview | ||
- [ ] Bumped up the version in VERSION file | ||
_Give a high level description of your changes._ | ||
|
||
## Testing | ||
|
||
## Rollout | ||
_Describe testing you did to ensure your changes work and that existing functionality was not broken by the changes._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
## Development | ||
|
||
### Build Locally | ||
|
||
Microplane is a Golang project. | ||
|
||
First, clone the repo. | ||
|
||
To install dependencies run | ||
``` | ||
make install_deps | ||
``` | ||
|
||
To build, run | ||
``` | ||
make build | ||
``` | ||
|
||
You should now have a working build of Microplane in `./bin/mp`. | ||
|
||
### Design | ||
|
||
Microplane parallelizes various git commands and API calls. | ||
|
||
At each step in the Microplane workflow, a repo only moves forward if the previous step for that repo was successful. | ||
|
||
We persist the progress of a Microplane run in the following local file structure. | ||
|
||
``` | ||
mp/ | ||
init.json | ||
repo1/ | ||
clone/ | ||
clone.json | ||
<git-repo> | ||
plan/ | ||
plan.json | ||
<git-repo-with-commit> | ||
push/ | ||
push.json | ||
merge/ | ||
merge.json | ||
repo2/ | ||
... | ||
``` | ||
|
||
### Releasing | ||
|
||
Before releasing: | ||
|
||
- Ensure you've tested microplane flow end to end. (future: improve integration tests) | ||
- PR your changes and get them reviewed. | ||
|
||
To publish a release: | ||
|
||
- Merge your approved pull request to `master`. | ||
- Push another commit to `master`, updating both `VERSION` with the new version and `CHANGELOG.md` with a description of the changes. | ||
- CircleCI will publish a release to GitHub. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.