Skip to content

Commit 4812157

Browse files
authored
chore: update github workflow and readme
1 parent 5e18586 commit 4812157

4 files changed

Lines changed: 34 additions & 8 deletions

File tree

.github/workflows/codeql-analysis.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ jobs:
3939

4040
steps:
4141
- name: Checkout repository
42-
uses: actions/checkout@v4
42+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6
4343

4444
# Initializes the CodeQL tools for scanning.
4545
- name: Initialize CodeQL
46-
uses: github/codeql-action/init@v3
46+
uses: github/codeql-action/init@7fd177fa680c9881b53cdab4d346d32574c9f7f4 #v3
4747
with:
4848
languages: ${{ matrix.language }}
4949
# If you wish to specify custom queries, you can do so here or in a config file.
@@ -54,7 +54,7 @@ jobs:
5454
# queries: security-extended,security-and-quality
5555

5656
- name: Set up JDK ${{ matrix.java }}
57-
uses: actions/setup-java@v4
57+
uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 #v5
5858
with:
5959
distribution: 'zulu'
6060
java-version: 8
@@ -88,4 +88,4 @@ jobs:
8888
atlas-package
8989
9090
- name: Perform CodeQL Analysis
91-
uses: github/codeql-action/analyze@v3
91+
uses: github/codeql-action/analyze@7fd177fa680c9881b53cdab4d346d32574c9f7f4 #v3

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,30 @@ codedx-bamboo-plugin
1212

1313
3. If needed, update the Swagger client [following the instructions here](SwaggerSetup.md). This shouldn't be needed but may be necessary if there is a version mismatch with the Code Dx server.
1414

15+
## Building the Plugin
16+
17+
### ⚠️ Important: Build `jersey-shaded` First
18+
19+
This project depends on a local shaded JAR (`jersey-shaded`) that is **not published to any remote Maven repository**. It must be installed into your local Maven repository before building the main plugin.
20+
21+
**Always follow this two-step build order:**
22+
23+
**Step 1 — Install `jersey-shaded` into your local Maven repository:**
24+
25+
```bash
26+
cd jersey-shaded
27+
atlas-mvn clean install
28+
cd ..
29+
```
30+
31+
**Step 2 — Build the main plugin:**
32+
33+
```bash
34+
atlas-mvn clean install
35+
```
36+
37+
> **Why?** `jersey-shaded` relocates Jersey 3.x and HK2 classes into the `com.codedx.shaded.*` namespace to avoid classloader conflicts with Bamboo's own Jersey packages.
38+
1539
## Running the Plugin
1640

1741
* It is recommended to run and debug the plugin from IntelliJ. Alternatively, it can be done from the command line.
@@ -20,6 +44,8 @@ codedx-bamboo-plugin
2044

2145
* First, open the Maven window on the right side of IntelliJ. If the window doesn't show any commands, use the `Reimport all Maven Projects` button and the `Generate Source and Update Folders for All Projects` button to populate the list.
2246

47+
* **Before running any lifecycle command from IntelliJ**, ensure `jersey-shaded` is already installed in your local Maven repository (see [Building the Plugin](#building-the-plugin) above). If you run the `clean` lifecycle from IntelliJ without doing this first, subsequent builds will fail until you re-install `jersey-shaded`.
48+
2349
* To clean the project, run the `codedx-bamboo-plugin/Lifecycle/clean` maven command.
2450

2551
* To run the project, run the `codedx-bamboo-plugin/Plugins/bamboo/bamboo:run` maven command.

jersey-shaded/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<modelVersion>4.0.0</modelVersion>
77
<groupId>com.codedx</groupId>
88
<artifactId>jersey-shaded</artifactId>
9-
<version>3.0.0</version>
9+
<version>3.0.1</version>
1010
<packaging>jar</packaging>
1111
<name>Jersey 3.x Shaded (relocated to com.codedx.shaded.*)</name>
1212
<description>

pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<modelVersion>4.0.0</modelVersion>
88
<groupId>com.codedx</groupId>
99
<artifactId>codedx-bamboo-plugin</artifactId>
10-
<version>3.0.0</version>
10+
<version>3.0.1</version>
1111

1212
<organization>
1313
<name>Code Dx</name>
@@ -49,14 +49,14 @@
4949
Build this module first: cd jersey-shaded && atlas-mvn install
5050
5151
All original Jersey/HK2 JARs are excluded here because they are already shaded
52-
(relocated) inside jersey-shaded-2.0.1.jar. Without these exclusions, Maven
52+
(relocated) inside jersey-shaded-3.0.1.jar. Without these exclusions, Maven
5353
would resolve the transitive deps and AMPS would embed the original
5454
org.glassfish.jersey.* classes alongside the shaded ones.
5555
-->
5656
<dependency>
5757
<groupId>com.codedx</groupId>
5858
<artifactId>jersey-shaded</artifactId>
59-
<version>3.0.0</version>
59+
<version>3.0.1</version>
6060
<exclusions>
6161
<exclusion>
6262
<groupId>org.glassfish.jersey.core</groupId>

0 commit comments

Comments
 (0)