Documentation (v2.0.0)

[pitbulk]

We need to add documentation to the project before release it at Maven.

There are already documentation that already exists at the PHP or Python toolkits.that we can follow as guide.

We need to describe the project scheme, how the settings works, the methods of the main auth class and describe the examples.

In the future we can add examples of how integrate this toolkit on the different Java frameworks.

[miszobi]

@pitbulk do you think you'll be able to work on this in the near future? Or would you want somebody else to try creating some docs?

[pitbulk]

I plan to start that documentation next week, but documentation about installation/integration on IDEs is welcome.

[jasmdk]

What is the status on this? Is documentation the only thing missing and if so do you still need help?
With regard to integration using Maven the only thing is to write the dependency snippet to include in your maven project - I can provide that for you if you would like that?

[pitbulk]

Any help is welcome. The example project I think already has the maven dependency snippet.

I was busy with issues on the rest of the toolkits but now I will be able to push java-saml again.

[pitbulk]

@miszobi , @jasmdk, @ThePetrov, @metal-hed

now we have some documentation, please review it and provide any extra info that you consider that we should add.

My plan is to execute the official release next week so please if you have some spare time, give some love to the documentation ;)

[miszobi]

Nice. Left some comments on the commit, but looks good to me in general.

[ThePetrov]

Looks good in general, added some questions/fixes on the commit

[metal-hed]

Looks good to me as well, looking forward to the release!

[pitbulk]

Now master is the v2.0.0 branch, I made the suggested changes, if there is no other comment, I plan to release it asap (need to learn first how Sonatype OSSRH works, but I think we are almost ready to publish there).

Related to documentation generated by docstring, correct me but I think that Sonatype can take care of it, right?

[miszobi]

Yes, generating the javadoc and source jars should already be handled by the release profile I've set up, then all of those should be uploaded as a part of the release process.

The instruction here should outline the most important steps. Remember to set up gpg upfront to sign the artifacts.

Let me know if you run into issues, I'll try to help.

[pitbulk]

I released 2.0.0 using the mvn command, but I got an error after update due javadocs.

[INFO] [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project java-saml-core: MavenReportException: Error while creating archive:
[INFO] [ERROR] Exit code: 1 - /home/pitbulk/proyectos/java-saml-onelogin/target/checkout/core/src/main/java/com/onelogin/saml2/authn/AuthnRequest.java:101: warning: no description for @throws
[INFO] [ERROR] * @throws IOException

I used on my local:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9.1</version>
    <configuration>
        <additionalparam>-Xdoclint:none</additionalparam>
    </configuration>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
         </execution>
    </executions>
</plugin>

and worked for execute the release... but failing when updaing to sonatype.

Any help?

[miszobi]

What's the error you're getting from Sonatype? Did you set up your account credentials in $HOME/.m2/settings.xml?

[pitbulk]

I think I experienced the error I mentioned

Failed to execute goal org.apache.maven.plugins:maven-release-plugin:2.5:perform (default-cli) on project java-saml-toolkit: Maven execution failed, exit code: '1'

at the end of the process since the github release was created, and you can see that the code was updated at sonatype:
https://oss.sonatype.org/content/repositories/snapshots/com/onelogin/java-saml-toolkit/

but nothing at stagging

[miszobi]

This is the snapshot version, while I'd expect a '2.0.0' (non-snapshot) to be produced as a part of the release. Could you attach the full output from the maven release process?

Maybe try setting up a gitter chat for the project, or just dm me on twitter (@miszobi), so we can chat without bouncing comments here?

[pitbulk]

Added you, I'm @lacarab at twitter, but I contacted you by gitter

[pitbulk]

Thanks all for the collaboration!