Permalink
Browse files

Problem: ssh-based inbox workflow is troublesome

Most importantly, since Git doesn't record file permissions,
the key that we distribute needs to have correct permissions before
ssh is used. That could have been done through scripts, but was
never accomplished.

Secondly, the command for pushing out is rather long
(`GIT_SSH_COMMAND="ssh -i sit-inbox" ...`).

Thirdly, it requires sit-inbox to be up and running.

Solution: use recently-developed email based workflow
(https://github.com/sit-fyi/sit-inbox)
  • Loading branch information...
yrashk committed Jul 21, 2018
1 parent 282e41a commit 21c47e2842462e1d9f27e2eea59590a62e1ca10d
Showing with 6 additions and 46 deletions.
  1. +3 −2 .sit/cli/mr-send-upstream
  2. +2 −3 CONTRIBUTING.md
  3. +1 −14 README.md
  4. +0 −27 sit-inbox
@@ -1,5 +1,6 @@
branch=$(git rev-parse --abbrev-ref HEAD)
echo
echo You can now push this MR upstream:
echo You can now send this MR to the inbox:
echo
echo GIT_SSH_COMMAND=\"ssh -i sit-inbox\" git push git@git.sit.fyi:sit-fyi/sit-inbox.git $1
echo git send-email --to=sit@inbox.sit.fyi ${branch}..$1
@@ -70,9 +70,8 @@ extend the above command to this:
sit mr <BRANCH> <ISSUE-ID>
```
Then, at the end, it will give you a command line to copy-paste to push the
request out (make sure you set up `issue` remote as per suggestion in
[README](README.md#send-updates-to-upstream)
Then, at the end, it will give you a command line to copy-paste to send the
request out.
<img src="doc/merge_request.gif">
@@ -132,24 +132,11 @@ you can send the updates to this repository:
1. Create a branch (as a convention, you can use your issue ID or an added record ID as a branch name, but free to choose anything else, preferrably unique)
2. Add new files in `.sit` and commit them. Commit message can be simply "Added issue <ISSUE-ID>"
or, say, "Commented on issue <ISSUE-ID>"
3. Push it out to the Inbox: `GIT_SSH_COMMAND="ssh -i sit-inbox" git push git@git.sit.fyi:sit-fyi/sit-inbox.git <branch>`
3. Send it out to the Inbox: `git send-email --to=sit@inbox.sit.fyi master..<branch>`
4. If the commit only contains new records (nothing else is permitted!) the Inbox
will accept the push and immediately forward it to sit's master repository on GitHub.
Otherwise, the push will be rejected.
To further simplify the process of sending records to the upstream,
it's highly recommended to add a remote (such as `issues`) for `git@git.sit.fyi:sit-fyi/sit-inbox.git`
and this to your `~/.ssh/config`:
```
host git.sit.fyi
HostName git.sit.fyi
IdentityFile /path/to/sit/repo/sit-inbox
User git
```
This way, pushing out, will be as nice as `git push issues <branch>`
### Preparing a merge request
Please refer to [CONTRIBUTING](https://github.com/sit-fyi/sit/blob/master/CONTRIBUTING.md#preparing-a-merge-request) for the instruction.

This file was deleted.

Oops, something went wrong.

0 comments on commit 21c47e2

Please sign in to comment.