Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use old log4j locally. See SWC-5894

Table of Contents
minLevel3

...

  1. Create a GitHub user account if you don't already have one.
    1. Contributors should fork the repository and submit GitHub Pull Requests for code inclusion.
  2. Set up Git: https://help.github.com/articles/set-up-git, and install git-secrets.

  3. Fork the Sage-Bionetworks SynapseWebClient repository into your own GitHub account: https://help.github.com/articles/fork-a-repo

  4. Clone the SynapseWebClient project down to your computer: 
    git clone https://github.com/[YOUR GITHUB NAME]/SynapseWebClient.git
  5. Change into the proper directory: 
    cd SynapseWebClient
  6. Set up the pre-commit hook to detect secrets (do this for all repos that you clone in the future!):
    git secrets --install
    git secrets --register-aws
  7. Set up upstream with: 
    git remote add upstream https://github.com/Sage-Bionetworks/SynapseWebClient
  8. Fetch and merge changes from the Sage Bionetworks repo, which was named upstream: 
    git fetch upstream
  9. Configure settings.xml –- its a configuration file for running maven
    1. The file needs to placed in $HOME/.m2/settings.xml (e.g. jane/.m2/settings.xml)
    2. This should be the content of this file:

      Code Block
      languagexml
      titlesettings.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:

...