Skip to content

Commit

Permalink
Update README about artifactory access
Browse files Browse the repository at this point in the history
Fixes #23
  • Loading branch information
finn-block committed Nov 15, 2024
1 parent 49f565f commit 2039c93
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

This project kickstarts your work in a new Java/Maven project.
It should get you building as quickly as possible - with best practices
and services baked in. It's designed for the Block Open Source Program, and may
and services baked in. It's designed for the Block Open Source Program, and may
be adapted for other contexts.

## Features

* Multimodule Maven project structure with 2 built-in modules: `api` and `impl`.
* [Hermit](https://cashapp.github.io/hermit/) managed environment (Java, Maven)
* GitHub Actions for Continuous Integration:
Expand All @@ -19,24 +20,25 @@ be adapted for other contexts.

## Usage

To build a project using this template as a base:
1. [Create a new repository](https://github.com/organizations/block/repositories/new).
To build a project using this template as a base:

1. [Create a new repository](https://github.com/organizations/block/repositories/new).

<img width="174" alt="image" src="https://github.com/user-attachments/assets/79660411-759b-4a64-9078-2b1740a9fc18">

2. Select
2. Select
`block/example-java-kotlin-maven-multimodule` as the `Repository template`.

<img width="499" alt="image" src="https://github.com/user-attachments/assets/c37259e0-4af8-4cd5-87ab-84a72cb9ad30">

## Preparing Your Project from This Template

There are a few steps you'll need to take from this
quickstart template to get your project ready for action.
There are a few steps you'll need to take from this
quickstart template to get your project ready for action.

### 🗺️ Change the Maven Coordinates

This example has `groupID` of `xyz.block` and `artifactId`s
This example has `groupID` of `xyz.block` and `artifactId`s
of `java-kotlin-maven-example-*`. You'll need to update all `pom.xml` files:

* `./pom.xml`
Expand All @@ -48,28 +50,28 @@ render your project unable to publish into Maven Central; the account we use
to publish is cleared for the `xyz.block` namespace.
Block employees may assistance by
[opening an internal issue](https://github.com/squareup/ospo/issues/new/choose) with the
Open Source Program Office if they need to use
Open Source Program Office if they need to use
a different `groupId`.

### 🔑 Get access to required GitHub Actions Secrets

The workflows on this project rely on GitHub Actions secrets,
environment variables, to run the build. The Open Source Program Office
team will, for security purposes, make these secrets available to your
The workflows on this project rely on GitHub Actions secrets,
environment variables, to run the build. The Open Source Program Office
team will, for security purposes, make these secrets available to your
project. The variables in question are:

* `SONATYPE_USERNAME` - A token tied to the Block OSS Sonatype account
* `SONATYPE_PASSWORD` - Password for the above
* `ARTIFACTORY_USERNAME` - User for the Block OSS Artifactory instance used to publish `SNAPSHOT`s on each build
* `ARTIFACTORY_PASSWORD` - Password for the above
* `GPG_SECRET_KEY` - Key used for signing releases
* `GPG_SECRET_PASSPHRASE` - Passphrase for above

Block employees may request access to these by
Your repo will also need access to the Artifactory repo for snapshot releases.

Block employees may request access to these by
[opening an internal issue](https://github.com/squareup/ospo/issues/new/choose) with the
Open Source Program Office.

### 🚀 Get Building!
### 🚀 Get Building

Go get 'em. 🤘🏻🤘🏼🤘🏽🤘🏾🤘🏿

Expand All @@ -81,7 +83,7 @@ Instructions are in [`CONTRIBUTING.md`](./CONTRIBUTING.md).

This is the part you adapt for your project's audience.

This stub is meant to help you form a strong community around your work. It's yours to adapt, and may
This stub is meant to help you form a strong community around your work. It's yours to adapt, and may
diverge from this initial structure. Just keep the files seeded in this repo, and the rest is yours to evolve!

## Introduction
Expand All @@ -95,12 +97,14 @@ Then maybe a dive into what this project does.
Diagrams and other visuals are helpful here. Perhaps code snippets showing usage.

Project leads should complete, alongside this `README`:

* [CODEOWNERS](./CODEOWNERS) - set project lead(s)
* [CONTRIBUTING.md](./CONTRIBUTING.md) - Fill out how to: install prereqs, build, test, run, access CI, chat, discuss, file issues
* [Bug-report.md](.github/ISSUE_TEMPLATE/bug-report.md) - Fill out `Assignees` add codeowners @names
* [config.yml](.github/ISSUE_TEMPLATE/config.yml) - remove "(/add your discord channel..)" and replace the url with your Discord channel if applicable

The other files in this template repo may be used as-is:

* [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
* [GOVERNANCE.md](./GOVERNANCE.md)
* [LICENSE](./LICENSE)
Expand Down

0 comments on commit 2039c93

Please sign in to comment.