Table of Contents | ||
---|---|---|
|
...
- Create a GitHub user account if you don't already have one.
- Contributors should fork the repository and submit GitHub Pull Requests for code inclusion.
Set up your local git environment according to Sage’s GitHub Security guidance
Fork the Sage-Bionetworks SynapseWebClient repository into your own GitHub account: https://help.github.com/articles/fork-a-repo
- Clone the SynapseWebClient project down to your computer:
git clone https://github.com/[YOUR GITHUB NAME]/SynapseWebClient.git
- Change into the proper directory:
cd SynapseWebClient
- Set up the If you didn't set up the global pre-commit hook in step #2, set up a local pre-commit hook to detect secrets (do this for all repos that you clone in the future!):
git secrets --install
git secrets --register-aws - Set up upstream with:
git remote add upstream https://github.com/Sage-Bionetworks/SynapseWebClient
- Fetch and merge changes from the Sage Bionetworks repo, which was named upstream:
git fetch upstream
- Configure settings.xml –- its a configuration file for running maven
- The file needs to placed in $HOME/.m2/settings.xml (e.g. jane/.m2/settings.xml)
This should be the content of this file:
Code Block language xml title settings.xml <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <localRepository/> <interactiveMode/> <usePluginRegistry/> <offline/> <pluginGroups/> <servers/> <mirrors/> <proxies/> <profiles> <profile> <id>dev-environment</id> <activation> <activeByDefault>true</activeByDefault> </activation> <properties> <log4j.version>2.8.2</log4j.version> <org.sagebionetworks.portal.endpoint>http://127.0.0.1:8888/Portal.html</org.sagebionetworks.portal.endpoint> <org.sagebionetworks.repositoryservice.endpoint>https://repo-prod.prod.sagebase.org/repo/v1</org.sagebionetworks.repositoryservice.endpoint> <!-- insert properties described below here --> <!-- <org.sagebionetworks.repositoryservice.endpoint>https://repo-staging.prod.sagebase.org/repo/v1</org.sagebionetworks.repositoryservice.endpoint> --> </properties> </profile> </profiles> <activeProfiles/> </settings>
...
Set the repository endpoint parameters in your maven settings.xml file.
To point to staging set:
<org.sagebionetworks.repositoryservice.endpoint>https://repo-staging.prod.sagebase.org/repo/v1</org.sagebionetworks.repositoryservice.endpoint>
To point to production set:
...