Skip to content

DOC: Update Github documentation #115

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.

Sign up for GitHub

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

Draft
ZryletTC wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

DOC: Update Github documentation #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0edc39
DOC: Create placeholder CONTRIBUTING.md
ZryletTC Mar 23, 2022
c858c69
Update README.md
ZryletTC Mar 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Contribution Guidelines
28 changes: 10 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,18 @@
# engineering_tools
A repository of scripts, configuration useful for the PCDS team
A repository of scripts and configurations useful for the PCDS team

## Push updates
```
git push -u origin master
```

## Add Tag
```
git tag -a R{tag} -m '{comment}'

git push -u origin R{tag}
```
## Contribution guidelines
Before making changes to this repository, please read the [contribution guidelines](https://github.com/pcdshub/engineering_tools/blob/docs_update/.github/CONTRIBUTING.md).

## Creating a new release
Navigate to https://github.com/pcdshub/engineering_tools/releases/new and create a new tag according to [semantic versioning](https://semver.org) conventions. You can use this same tag for the "Release title" or make up something more creative. For the description the "Auto-generate release notes" button works quite well but feel free to add additional comments at the top if you feel so inclined. Click the green button to publish the release then proceed to deploy this release on the LCLS servers:
```
# Clone the source code into a new folder
git clone https://github.com/pcdshub/engineering_tools.git R{tag}
# Enter repository
cd R{Tag}
# checkout tag number
git checkout tags/R{tag}
# Navigate to the main engineering_tools directory
cd /cds/group/pcds/engineering_tools
# Deploy using the pkg_release script
pkg_release engineering_tools R{tag}
# Repoint the latest-released link to your new release
ln -nsf R{tag} latest-released
```

## Updating latest
Expand Down