{"type":"doc","content":[{"type":"paragraph","content":[{"text":"CollectionSpace hosts an Apache Maven repository on Amazon S3. This repository contains compiled CollectionSpace components, as well as some third party libraries. Deploying artifacts to the Maven repository happens rarely, and only when:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A new version of CollectionSpace is released. Release versions of compiled CollectionSpace components are deployed. (Note: It’s uncertain if anyone is using CollectionSpace components to build their own applications, so this may not be needed.)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A new snapshot of the upcoming CollectionSpace release is needed. (Note: It’s uncertain if anyone is using CollectionSpace components to build their own applications, so this may actually never be needed.)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CollectionSpace’s Nuxeo dependencies are upgraded to a newer version. The latest hotfix release of the targeted version is compiled from source, and the resulting artifacts are deployed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A third-party library used by CollectionSpace becomes unavailable. This may happen if the artifact is hosted on a project’s own Maven repository, and that project becomes unsupported; access to that repository may be terminated. In this case, a copy of the artifact may be uploaded to CollectionSpace’s repository, so that builds may continue while an alternative library is found.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Set Up","type":"text"}]},{"type":"paragraph","content":[{"text":"Deploying to the CollectionSpace Maven repository requires write access to the ","type":"text"},{"text":"cspace-maven-repo","type":"text","marks":[{"type":"code"}]},{"text":" S3 bucket. If you need this access, ask a CollectionSpace developer for instructions, or email ","type":"text"},{"text":"talk@lists.collectionspace.org","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:talk@lists.collectionspace.org"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"To continue, you will need the access key and secret of an appropriate AWS user.","type":"text"}]},{"type":"paragraph","content":[{"text":"Create (or edit) the ","type":"text"},{"text":".m2/settings.xml","type":"text","marks":[{"type":"code"}]},{"text":" file in your home directory. Enter a server configuration, as in the following example:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n\t\n\t\t\n\t\t\tcspace\n\t\t\t{key}\n\t\t\t{secret}\n\n\t\t\t\n\t\t\t\tus-west-2\n\t\t\t\n\t\t\n\t\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" must be ","type":"text"},{"text":"cspace","type":"text","marks":[{"type":"code"}]},{"text":", because this corresponds to the ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" found in ","type":"text"},{"text":"pom.xml","type":"text","marks":[{"type":"code"}]},{"text":" files in CollectionSpace source code.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"username","type":"text","marks":[{"type":"code"}]},{"text":" should be your AWS access key, and the ","type":"text"},{"text":"password","type":"text","marks":[{"type":"code"}]},{"text":" should be your secret. The ","type":"text"},{"text":"region","type":"text","marks":[{"type":"code"}]},{"text":" must be ","type":"text"},{"text":"us-west-2","type":"text","marks":[{"type":"code"}]},{"text":", since this is where the S3 bucket resides.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Deploying CollectionSpace Components","type":"text"}]},{"type":"paragraph","content":[{"text":"To compile and deploy CollectionSpace services components, use the following command in the services source directory:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"mvn clean deploy -DskipTests","type":"text"}]},{"type":"paragraph","content":[{"text":"If the version of the project (defined in ","type":"text"},{"text":"pom.xml","type":"text","marks":[{"type":"code"}]},{"text":") contains ","type":"text"},{"text":"-SNAPSHOT","type":"text","marks":[{"type":"code"}]},{"text":", the resulting artifacts will be deployed to the ","type":"text"},{"text":"libs-snapshot-local","type":"text","marks":[{"type":"code"}]},{"text":" folder in the ","type":"text"},{"text":"cspace-maven-repo","type":"text","marks":[{"type":"code"}]},{"text":"bucket. Otherwise, they will be deployed to the ","type":"text"},{"text":"libs-release-local","type":"text","marks":[{"type":"code"}]},{"text":" folder.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Deploying Nuxeo Components","type":"text"}]},{"type":"paragraph","content":[{"text":"TODO: Need to update these instructions: ","type":"text"},{"text":"https://collectionspace.atlassian.net/wiki/spaces/collectionspace/pages/666272662/Deploy+Nuxeo+Artifacts+jars+to+CSpace+s+Artifactory+Repository","type":"text","marks":[{"type":"link","attrs":{"href":"https://collectionspace.atlassian.net/wiki/spaces/collectionspace/pages/666272662/Deploy+Nuxeo+Artifacts+jars+to+CSpace+s+Artifactory+Repository"}}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Deploying Third-Party Libraries","type":"text"}]},{"type":"paragraph","content":[{"text":"To deploy third-party libraries, locate a ","type":"text"},{"text":".jar","type":"text","marks":[{"type":"code"}]},{"text":" file and a ","type":"text"},{"text":"pom.xml","type":"text","marks":[{"type":"code"}]},{"text":" file for the library. These may exist in your local Maven repository, in the ","type":"text"},{"text":".m2/repository","type":"text","marks":[{"type":"code"}]},{"text":" directory in your home directory. If they are in your local repository, copy the files out before continuing. Files may not be deployed directly from the local repository.","type":"text"}]},{"type":"paragraph","content":[{"text":"Use the following command in the services source directory:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"mvn deploy:deploy-file \\\n-Durl=s3://cspace-maven-repo/libs-release-local \\\n-DrepositoryId=cspace \\\n-Dfile={path_to_jar_file} \\\n-DpomFile={path_to_pom_file}","type":"text"}]},{"type":"paragraph","content":[{"text":"Replace ","type":"text"},{"text":"{path_to_jar_file}","type":"text","marks":[{"type":"code"}]},{"text":" with the location of the ","type":"text"},{"text":".jar","type":"text","marks":[{"type":"code"}]},{"text":" file you want to deploy, and ","type":"text"},{"text":"{path_to_pom_file}","type":"text","marks":[{"type":"code"}]},{"text":"with the location of the ","type":"text"},{"text":"pom.xml","type":"text","marks":[{"type":"code"}]},{"text":" file. If the version of the library is a snapshot (the filename contains ","type":"text"},{"text":"-SNAPSHOT","type":"text","marks":[{"type":"code"}]},{"text":"), replace ","type":"text"},{"text":"libs-release-local","type":"text","marks":[{"type":"code"}]},{"text":" with ","type":"text"},{"text":"libs-snapshot-local","type":"text","marks":[{"type":"code"}]},{"text":" in the url.","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported