Commit e93bd33f authored by Thibaud Marie Eric Buffet's avatar Thibaud Marie Eric Buffet
Browse files

Merge branch 'update_ci_dev_eos' into 'dev'

contributing

See merge request !4
parents abb50c86 3c355008
Pipeline #2518659 passed with stage
in 11 seconds
/.idea/
**/.sys.v#.*.ipynb/
**.sys.v#.*
......
......@@ -35,6 +35,9 @@ deploy_dev_eos:
- deploy-eos
before_script: []
after_script: []
only:
- master
- dev
deploy_production_eos:
stage: deploy
......
# Contributing Manual
## Issue reporting and tracking
To report issues and track their progress we use a [JIRA dashboard](https://its.cern.ch/jira/secure/RapidBoard.jspa?rapidView=7215&projectKey=SIGMON&view=detail).
- When a new issue is raised, one can report it by creating a new story on the JIRA board on the `Create` button.
- This new story/task should be assigned yourself as a `Reporter` and `Assignee` and put into the `BACKLOG` column.
- The issue must contain a complete and explicit description. Feel free to use images, screenshots or figures to illustrate the issue.
- It is now waiting for someone to check it out and start working on it.
Note: issues can move back to their previous steps if needed.
## Fixing an issue
### 1. Open a new SWAN session with the configuration
- Software stack: `NXCals Python3`
- Platform: `CentOS 7 (gcc7)` - default
- Environment script: `/eos/project/l/lhcsm/public/contributor.sh`
- Number of cores: `4`
- Memory: `16 GB`
- Spark cluster: `BE NXCALS (NXCals)`
##### On JIRA dashboard:
- If not done already, put yourself as `Assignee` of the issue.
- Move the issue to the `IN PROGRESS` column.
### 2. The repository `hwc_working` has been created or loaded. All the notebooks can be updated from this repository.
- Update and modify notebooks from `hwc_working` in order to fix the issue.
- You can continue to work on your Notebooks for several days by repeating step 1. when reloading a SWAN session.
- __IMPORTANT__ -> Issues can occur if multiple people are working in parallel on the same Notebooks. Make sure to synchronise with other developers.
### 3. Commit and push your changes to Gitlab:
- __IMPORTANT__ -> Before pushing all the notebooks must stay __CLEAN__ !! They should **NOT** contain any SWAN execution outputs.
To clean a notebook click on the tab `CELL` --> `All Output->Clear`
- __IMPORTANT__ -> Increment the version number in the `hwc_working/__init__.py` file.
- Open the SWAN terminal.
- Then run the command `source /eos/project/l/lhcsm/public/contributor_push.sh`
- (Note the working directory `hwc_working` has been deleted, if you want to reload it you can run in the terminal `source /eos/project/l/lhcsm/public/contributor.sh`)
### 4. Open a merge request on [Gitlab with your changes to be reviewed](https://gitlab.cern.ch/LHCData/lhc-sm-hwc/-/merge_requests):
- select source branch `dev`
- select target branch `master`
- The merge request is waiting review from software experts.
##### On JIRA dashboard:
- When the merge request is open move the issue to the `REVIEW` column.
### 5. Once the merge request has been reviewed and approved then click on the `Merge` button of the merge request page.
- The `DEV` [pipeline](https://gitlab.cern.ch/LHCData/lhc-sm-api/-/pipelines) is now triggered. Wait until the pipeline is completed and all steps are green.
- To load the `DEV` environment you can restart the SWAN configuration with the option Environment script: `/eos/project/l/lhcsm/public/packages_notebooks_dev.sh`
- On this `DEV` environment experts (you?) can validate that all the changes are correct.
##### On JIRA dashboard:
- During validation on the `DEV` environment by experts, move the task to `VALIDATION` column.
### RELEASE TO PRO
### 6. When changes are validated, you must __TAG__ the `master` branch with the previously given **_version_ _number_**: https://gitlab.cern.ch/LHCData/lhc-sm-hwc/-/tags/new
- The `PRO` [pipeline](https://gitlab.cern.ch/LHCData/lhc-sm-api/-/pipelines) is now triggered. Wait until the pipeline is completed and all steps are green.
- To load the `PRO` environment you can restart the SWAN configuration with the option Environment script: `/eos/project/l/lhcsm/public/packages_notebooks.sh`
##### On JIRA dashboard:
- The issue is fixed and can be moved to `DONE` column.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment