Skip to content

Commit

Permalink
Release LDAP API 2.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
seelmann committed May 26, 2021
1 parent 11c22a7 commit dbac8b1
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 60 deletions.
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ date = ["date", ":filename", "publishDate", "lastmod"]
[params]
version_apacheds = "2.0.0.AM26"
version_api = "1.0.3"
version_api2 = "2.0.1"
version_api2 = "2.0.2"
version_fortress = "2.0.5"
version_kerby = "2.0.1"
version_mavibot = "1.0.0-M8"
Expand Down
83 changes: 26 additions & 57 deletions source/api/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -405,70 +405,36 @@ We will copy two directories :
apidocs
xref

*Staging or Production?*
They are uploaded to https://nightlies.apache.org/ via WebDAV protocol.

<DIV class="info" markdown="1">
Those files will be stored on the production server only !!! And some extra caution ust be taken not to delete them when we will publish the staging site too...
</DIV>

First of all, you must checkout the two CMS store for the site : staging and production.


$ cd ~/apacheds
$ svn co https://svn.apache.org/repos/infra/websites/staging/directory/trunk staging
...
$ svn co https://svn.apache.org/repos/infra/websites/production/directory production
...

Now, you will first add the directory for the newly generated version :


$ cd ~/apacheds/production/content/api/gen-docs
$ mkdir <version>
$ svn add <version>

Then copy the generated docs :


$ cp -r ~/apacheds/trunks/api/target/checkout/target/site/apidocs ~/apacheds/production/content/api/gen-docs/<version>
$ cp -r ~/apacheds/trunks/api/target/checkout/target/site/xref ~/apacheds/production/content/api/gen-docs/<version>
$
First create the folders for the version:

You have to check in those directories :
$ curl -u yourasfid -X MKCOL 'https://nightlies.apache.org/directory/api/2.0.2/'
$ curl -u yourasfid -X MKCOL 'https://nightlies.apache.org/directory/api/2.0.2/apidocs'
$ curl -u yourasfid -X MKCOL 'https://nightlies.apache.org/directory/api/2.0.2/xref'


$ svn add <version>/*
$ svn ci <version> -m "Injected <version> javadocs"
I used [Rclone](https://rclone.org/) to copy folders via WebDAV.

Now, you have to update the staging site <em>extpaths.txt</em>
After intallation run `rclone config` and configure the `nightlies` connection:

This file list the file on the production site that will not be overriden by the publication of the staging site. It has to be updated
$ rclone config
name: nightlies
type: webdav
url: https://nightlies.apache.org
vendor: other
user: yourasfid
pass: yourasfpassword (will be stored encrypted)


$ cd ~/apacheds/staging/content/
$ vi extpaths.txt
Then copy the directories:

Add the following line :
cd target/checkout/target/site
rclone copy --progress apidocs nightlies:/directory/api/2.0.2/apidocs
rclone copy --progress xref nightlies:/directory/api/2.0.2/xref


...
# API
api/gen-docs/<version>
...

then save and check in the file <em>extpaths.txt</em>
Finally update the links in the `static/api/gen-docs/.htaccess` of the directory-site repo:

We also have to update the <em>.htaccess</em> file :


$ cd ~/apacheds/staging/content/api/gen-docs
$ vi .htaccess

And update the two last lines to refer to the version you've just released :


RewriteRule ^latest$ <version>/
RewriteRule ^latest/(.*)$ <version>/$1
RewriteRule ^latest2$ https://nightlies.apache.org/directory/api/2.0.2/ [QSA,L]
RewriteRule ^latest2/(.*)$ https://nightlies.apache.org/directory/api/2.0.2/$1 [QSA,L]

Save and commit the file.

Expand All @@ -478,13 +444,16 @@ You can now update the site, add a news on the front page, and publish the site.

There are a few places to modify :

* /config.toml : update the version_api variable with the new version.
* /source/_index.md : same here, update the <!-- LDAP API project --> section, which contains the version.
* /config.toml : update the `version_api2` variable with the new version.
* /source/api/news.md : add the news on top of this page
* /source/api/download-old-versions.md : add a new line on top of the array, which refers to the latest version before the new one

Commit the changes, and publish the web site, you are done !

### Update Apache Reporter

Add release to https://reporter.apache.org/addrelease.html?directory

### Inform the world !

After 24h, you can now inform the world about the release.
Expand Down
1 change: 1 addition & 0 deletions source/api/download-old-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ title: Download Old Versions

| Version| Download Link | Javadoc & XRef | Date |
|:-:|:-:|:-:|:-:|
| Apache LDAP API 2.0.1 | [Download](https://archive.apache.org/dist/directory/api/dist/2.0.1) | [Javadoc](https://svn.apache.org/repos/infra/websites/production/directory/content/api/gen-docs/2.0.1/apidocs/index.html), [Xref](https://svn.apache.org/repos/infra/websites/production/directory/content/api/gen-docs/2.0.1/xref/index.html) |26/Mar/2020 |
| Apache LDAP API 2.0.0 | [Download](https://archive.apache.org/dist/directory/api/dist/2.0.0) | [Javadoc](https://svn.apache.org/repos/infra/websites/production/directory/content/api/gen-docs/2.0.0/apidocs/index.html), [Xref](https://svn.apache.org/repos/infra/websites/production/directory/content/api/gen-docs/2.0.0/xref/index.html) |13/Nov/2019 |
| Apache LDAP API 2.0.0.AM4 | [Download](https://archive.apache.org/dist/directory/api/dist/2.0.0.AM4) | [Javadoc](https://svn.apache.org/repos/infra/websites/production/directory/content/api/gen-docs/2.0.0.AM4/apidocs/index.html), [Xref](https://svn.apache.org/repos/infra/websites/production/directory/content/api/gen-docs/2.0.0.AM4/xref/index.html) |09/Jun/2019 |
| Apache LDAP API 2.0.0.AM3 | [Download](https://archive.apache.org/dist/directory/api/dist/2.0.0.AM3) | [Javadoc](https://svn.apache.org/repos/infra/websites/production/directory/content/api/gen-docs/2.0.0.AM3/apidocs/index.html), [Xref](https://svn.apache.org/repos/infra/websites/production/directory/content/api/gen-docs/2.0.0.AM3/xref/index.html) |15/May/2019 |
Expand Down
33 changes: 33 additions & 0 deletions source/api/news.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,39 @@ title: News
---

# News
<h2 class="news">Apache Directory LDAP API 2.0.2 released <em>posted on May 25th, 2021</em></h2>

The Apache Directory Team is proud to announce the availability of version 2.0.2 of the Apache Directory LDAP API.

The Apache Directory LDAP API is an ongoing effort to provide an enhanced LDAP API, as a replacement for JNDI and the existing LDAP API (jLdap and Mozilla LDAP API).

This is a schema aware API, with some convenient ways to access a LDAP server. This API is not only targeting the Apache Directory Server, but should work pristine with any LDAP server.

It's also an extensible API : new Controls, schema elements and network layer could be added or used in the near future. It's also OSGi capable.

This is a bug fix and maintenance release:

**Bugs:**

* [DIRAPI-358](https://issues.apache.org/jira/browse/DIRAPI-358) - File Descriptor leak on connection failure with LdapConnectionTemplate
* [DIRAPI-364](https://issues.apache.org/jira/browse/DIRAPI-364) - Internal Error in response when using authRequest
* [DIRAPI-365](https://issues.apache.org/jira/browse/DIRAPI-365) - unable to use # pound hash sign in LDAP filters
* [DIRAPI-366](https://issues.apache.org/jira/browse/DIRAPI-366) - NPE for reading Root DSE with Oracle Unified Directory
* [DIRAPI-368](https://issues.apache.org/jira/browse/DIRAPI-368) - StackOverflowError when working with entries with thousands of attributes or values
* [DIRAPI-370](https://issues.apache.org/jira/browse/DIRAPI-370) - LdifReader does not preserve user provided attribute name
* [DIRAPI-371](https://issues.apache.org/jira/browse/DIRAPI-371) - Misleading Javadoc in Dn.add()

**Improvement:**

* [DIRAPI-359](https://issues.apache.org/jira/browse/DIRAPI-359) - Propagate exceptions that are caught during the response handling

**Wish:**

* [DIRAPI-372](https://issues.apache.org/jira/browse/DIRAPI-372) - Publish new Version on Maven Central to get rid of vulnerable dependency

Downloads are available [here](downloads-2.html) and the User's Guide is [there](user-guide.html)


<h2 class="news">Apache Directory LDAP API 2.0.1 released <em>posted on March 26th, 2020</em></h2>

The Apache Directory Team is proud to announce the availability of version 2.0.1 of the Apache Directory LDAP API.
Expand Down
4 changes: 2 additions & 2 deletions static/api/gen-docs/.htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ RewriteEngine On
RewriteRule ^latest$ https://nightlies.apache.org/directory/api/1.0.2/ [QSA,L]
RewriteRule ^latest/(.*)$ https://nightlies.apache.org/directory/api/1.0.2/$1 [QSA,L]

RewriteRule ^latest2$ https://nightlies.apache.org/directory/api/2.0.1/ [QSA,L]
RewriteRule ^latest2/(.*)$ https://nightlies.apache.org/directory/api/2.0.1/$1 [QSA,L]
RewriteRule ^latest2$ https://nightlies.apache.org/directory/api/2.0.2/ [QSA,L]
RewriteRule ^latest2/(.*)$ https://nightlies.apache.org/directory/api/2.0.2/$1 [QSA,L]

# Redirect everything else
RewriteRule ^(.*)$ https://nightlies.apache.org/directory/api/$1 [QSA,L]
Expand Down

0 comments on commit dbac8b1

Please sign in to comment.