Initial documentation #1

allenhsieh · 2019-09-30T16:59:08Z

Initial documentation for APK Community Format

DarthHater · 2019-09-30T17:07:21Z

Dockerfile

+ARG NEXUS_BUILD=SNAPSHOT
+
+COPY . /nexus-repository-apk/
+RUN cd /nexus-repository-apk/; sed -i "s/3.19.0-02/${NEXUS_VERSION}-${NEXUS_BUILD}/g" pom.xml; \


Make sure to check if this is the actual released version of 3.19.0

So we don't really need these manipulations any more and the 'sed' voodoo. See link in comment below for a simpler Dockerfile (from the nexus-format-archetype code base).

in: 72661e1

DarthHater · 2019-09-30T17:07:51Z

Dockerfile

+
+FROM sonatype/nexus3:$NEXUS_VERSION
+ARG NEXUS_VERSION=3.19.0
+ARG NEXUS_BUILD=SNAPSHOT


This looks unused? Should it be removed?

I managed to get rid of most of the NXRM version specific stuff in the Dockerfile. Here is a simpler Dockerfile from the nexus-format-archetype code base. You could just replace all occurrences of "foo" with "apk", and change the FORMAT_VERSION ARG value from "0.0.1" to "0.0.1-SNAPSHOT".

In: 72661e1

bhamail

I suggested a few tweaks, hopefully simplifying in nature.

I will also setup a "write key" so the project will be ready to published to central after the CI config is merged.

bhamail · 2019-09-30T18:15:39Z

Dockerfile

+ARG NEXUS_BUILD=SNAPSHOT
+
+COPY . /nexus-repository-apk/
+RUN cd /nexus-repository-apk/; sed -i "s/3.19.0-02/${NEXUS_VERSION}-${NEXUS_BUILD}/g" pom.xml; \


So we don't really need these manipulations any more and the 'sed' voodoo. See link in comment below for a simpler Dockerfile (from the nexus-format-archetype code base).

bhamail · 2019-09-30T18:15:44Z

Dockerfile

+
+FROM sonatype/nexus3:$NEXUS_VERSION
+ARG NEXUS_VERSION=3.19.0
+ARG NEXUS_BUILD=SNAPSHOT


I managed to get rid of most of the NXRM version specific stuff in the Dockerfile. Here is a simpler Dockerfile from the nexus-format-archetype code base. You could just replace all occurrences of "foo" with "apk", and change the FORMAT_VERSION ARG value from "0.0.1" to "0.0.1-SNAPSHOT".

bhamail · 2019-09-30T18:16:18Z

pom.xml

@@ -19,7 +19,7 @@
  </parent>

  <artifactId>apk-parent</artifactId>
-  <version>0.0.1</version>
+  <version>0.0.0</version>


FWIW, I'd like to encourage we start using a "-SNAPSHOT" suffix on the version numbers. (I've updated the nexus-format-archetype to do this).
The ORB we use for releasing will handle versions like 0.0.1-SNAPSHOT. One downside is you have to remember to manually bump the version to the next development SNAPSHOT after doing a release.

In: c2b77ee

Based on conversation with @DarthHater, we are going to reverse this change and open an issue to revisit

allenhsieh · 2019-09-30T23:22:57Z

Added user documentation

aornatovskyy · 2019-10-02T14:01:56Z

README.md

+### Requirements
+
+* [Apache Maven 3.3.3+](https://maven.apache.org/install.html)
+* [Java 8+](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)


Java8. remove + sign

in: 09471e2

aornatovskyy · 2019-10-02T14:03:48Z

nexus-repository-apk-it/pom.xml

@@ -5,7 +5,7 @@
  <parent>
    <groupId>org.sonatype.nexus.plugins</groupId>
    <artifactId>apk-parent</artifactId>
-    <version>0.0.1</version>
+    <version>0.0.0-SNAPSHOT</version>


in the readme, we have just 0.0.1 here it is -with Snapshot. Need to align to one stile

Thank you! I'll reach out to @bhamail and @DarthHater for clarification, I was under the impression circleCI was going to rev it to 0.0.1 but i have a feeling my understanding was wrong.

aornatovskyy · 2019-10-02T14:10:19Z

...s-repository-apk/src/main/java/org/sonatype/nexus/plugins/apk/internal/ApkSecurityFacet.java

@@ -1,6 +1,6 @@
 /*
 * Sonatype Nexus (TM) Open Source Version
- * Copyright (c) 2018-present Sonatype, Inc.
+ * Copyright (c) 2019-present Sonatype, Inc.


was it changed automatically?

@aornatovskyy No this was changed manually, most of the documentation was carried over from other community formats and repurposed for the APK community format. I put 2019 since this is a brand new community format (i based the date on first commit year)

No legalese here but I feel like that's appropriate fwiw, it should be creation and beyond.

This is correct, it should be the year the plugin/project was created.

aornatovskyy · 2019-10-02T14:15:55Z

docs/APK_USER_DOCUMENTATION.md

+
+You can create a proxy repository in Nexus Repository Manager that will cache packages from a remote APK repository, like
+http://dl-cdn.alpinelinux.org/alpine/v3.10/main/. Then, you can make `Alpine` use your Nexus Repository Proxy 
+instead of the remote repository by editing `/etc/apk/repositories`. More information can be found [here](https://wiki.alpinelinux.org/wiki/Enable_Community_Repository). You may need to first install nano/vim/etc for this to work (i.e. `apk add nano`). 


nano/vim/etc looks like we have such editor "etc". but at the same time I can put any editor name instead of "etc" @joedragons what do u think about this construction?

I agree with you @aornatovskyy . Perhaps "install an editor, such as nano, vim, etc.," however, I'm not confident on my suggestion since I'm not sure what we're having work. Editing /etc/apk/repositories?
If so, I don't personally feel we need to tell them they may need something to edit a file. If you disagree, I think my confusion is mostly because there's a link in between the edit statement and the "work" statement.

@aornatovskyy @joedragons Thank you both! I absolutely see the confusion, and yes @joedragons, the work requested of the user is to have them edit the file located at /etc/apk/repositories. I'll change for clarification.

in: 09471e2

docs/APK_USER_DOCUMENTATION.md

.github/ISSUE_TEMPLATE.md

joedragons · 2019-10-02T14:39:57Z

README.md

+
+| Plugin Version | Nexus Repository Version |
+|----------------|--------------------------|
+| v0.0.1         | 3.19.0-SNAPSHOT          |


NOTE: I'm surprised this isn't 3.19.0-1 or 3.20.0-SNAPSHOT given our recent release. I believe you, but just surprised (thus NOTE).

Great note! I was unsure myself, @DarthHater what should i be putting for version #? The POMs all reference 3.19.0-SNAPSHOT:

We need to sort that out. Now that 3.19.0-01 is out, I think the best thing to do would be to cut a release that uses that, and then work with @bhamail to figure out how we want SNAPSHOT stuff to be in the repos.

README.md

docs/APK_USER_DOCUMENTATION.md

joedragons · 2019-10-02T17:26:39Z

Looks good to me textually. I don't know about the dockerfile or config.yml but if you'd like my +1 sans that you got it (let me know if you'd like formally). Thanks!

DarthHater

This is more or less good, I think! Moving forward on other projects it probably makes sense to separate some of the stuff into different PRs, but for this special little snowflake of a project I think this is fine.

allenhsieh added 11 commits September 27, 2019 09:05

started README

a3d4a45

github boilerplate

893367a

circleci boilerplate

b1551bf

import of license

d45ee91

license year + owner change

99c19b2

changed copyright date

cc0d9a6

maven central and contributers boilerplate

1f6174d

changed license from Apache to EPL

0d0b323

initial import of dockerfile from conda artifact

ff49a25

modified dockerfile to proper nexus version

3a67a87

Merge remote-tracking branch 'origin/master' into docs

4d6ef60

allenhsieh requested a review from DarthHater September 30, 2019 16:59

DarthHater reviewed Sep 30, 2019

View reviewed changes

updated version# in poms so circleCI handles revving

a7cc077

allenhsieh requested a review from bhamail September 30, 2019 17:31

bhamail reviewed Sep 30, 2019

View reviewed changes

allenhsieh added 4 commits September 30, 2019 16:07

added user documentation

72661e1

user documentation linked

ca4cc64

changed all versions numbers to have suffix -SNAPSHOT

c2b77ee

remove repeating word

e77094b

allenhsieh requested a review from aornatovskyy October 1, 2019 16:42

allenhsieh self-assigned this Oct 1, 2019

aornatovskyy reviewed Oct 2, 2019

View reviewed changes