ci: adopt reusable workflows from named-data/actions

Switch source archive (tarball) to xz compression and
mention using gerrit for code review in the README

Change-Id: Ie69de065311737f6fe48976fbab5f896f3960e06

.github/workflows/ci.yml

@@ -1,65 +1,12 @@
 name: CI
 on:
   push:
-    paths-ignore:
-      - 'docs/**'
-      - '*.md'
-      - '.mailmap'
   workflow_dispatch:
 
-permissions:
+permissions: {}
-  contents: read
 
 jobs:
-  linux:
+  Ubuntu:
-    name: ${{ matrix.compiler }} on ${{ matrix.os }}
+    uses: named-data/actions/.github/workflows/jenkins-script-ubuntu.yml@v1
-    runs-on: ${{ matrix.os }}
+  macOS:
-    strategy:
+    uses: named-data/actions/.github/workflows/jenkins-script-macos.yml@v1
-      fail-fast: false
-      matrix:
-        os: [ubuntu-20.04]
-        compiler: [g++-7, g++-8, g++-9, g++-10,
-                   clang++-7, clang++-8, clang++-9, clang++-10, clang++-11, clang++-12]
-        include:
-          - os: ubuntu-22.04
-            compiler: g++-11
-          - os: ubuntu-22.04
-            compiler: g++-12
-          - os: ubuntu-22.04
-            compiler: clang++-13
-          - os: ubuntu-22.04
-            compiler: clang++-14
-    env:
-      CXX: ${{ matrix.compiler }}
-    steps:
-      - name: Install C++ compiler
-        run: |
-          sudo apt-get -qy install ${CXX/clang++/clang}
-          ${CXX} --version
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Build and test
-        run: ./.jenkins
-
-  macos:
-    name: Xcode ${{ matrix.xcode }} on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos-11]
-        xcode: ['12.4', '12.5', '13.2']
-        include:
-          - os: macos-12
-            xcode: '13.4'
-          - os: macos-12
-            xcode: '14.2'
-    steps:
-      - name: Set up Xcode
-        uses: maxim-lobanov/setup-xcode@v1
-        with:
-          xcode-version: ${{ matrix.xcode }}
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Build and test
-        run: ./.jenkins

.github/workflows/docs.yml

@@ -1,33 +1,19 @@
 name: Docs
 on:
   push:
-    paths-ignore:
-      - '*.md'
-      - '.mailmap'
   workflow_dispatch:
+    inputs:
+      skip-deploy:
+        description: 'Skip deployment?'
+        required: true
+        type: boolean
 
-permissions:
+permissions: {}
-  contents: read
 
 jobs:
-  build:
+  html:
-    runs-on: ${{ matrix.os }}
+    uses: named-data/actions/.github/workflows/docs-html.yml@v1
-    strategy:
+    with:
-      fail-fast: false
+      # Deploy only the master branch and release tags
-      matrix:
+      deploy: ${{ !inputs.skip-deploy && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/0.')) }}
-        os: [macos-latest, ubuntu-latest]
+    secrets: inherit
-    env:
-      JOB_NAME: Docs
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Install dependencies
-        run: |
-          find .jenkins.d/ -type f -name '[1-9]*.sh' -exec chmod -x '{}' +
-          ./.jenkins
-      - name: Build documentation
-        run: |
-          pybindir=$(python3 -c 'import sysconfig; print(sysconfig.get_path("scripts", "posix_user"))')
-          export PATH="${pybindir}${PATH:+:}${PATH}"
-          ./waf --color=yes configure
-          ./waf --color=yes docs

AUTHORS.md

@@ -2,7 +2,7 @@
 
 The following lists maintainers, primary developers, and all much-appreciated contributors to PSync in alphabetical order.
 The specific contributions of individual authors can be obtained from the git history of the [official PSync repository](https://github.com/named-data/PSync).
-If you would like to become a contributor to the official repository, please follow the recommendations in <https://github.com/named-data/.github/blob/master/CONTRIBUTING.md>.
+If you would like to become a contributor to the official repository, please follow the recommendations in <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>.
 
 * Alexander Afanasyev <https://users.cs.fiu.edu/~afanasyev>
 * ***(Maintainer)*** Saurab Dulal <https://dulalsaurab.github.io>

README.md

@@ -19,7 +19,7 @@ PSync uses the [ndn-cxx](https://github.com/named-data/ndn-cxx) library.
 
 ### Prerequisites
 
-* [ndn-cxx and its dependencies](https://named-data.net/doc/ndn-cxx/current/INSTALL.html)
+* [ndn-cxx and its dependencies](https://docs.named-data.net/ndn-cxx/current/INSTALL.html)
 
 ### Build
 
@@ -29,11 +29,11 @@ To build PSync from source:
     ./waf
     sudo ./waf install
 
-To build on memory constrained platform, please use `./waf -j1` instead of `./waf`. The
+To build on memory constrained systems, please use `./waf -j1` instead of `./waf`. This
-command will disable parallel compilation.
+will disable parallel compilation.
 
 If configured with tests (`./waf configure --with-tests`), the above commands will also
-generate unit tests that can be run with `./build/unit-tests`.
+build a suite of unit tests that can be run with `./build/unit-tests`.
 
 ## Reporting bugs
 
@@ -42,10 +42,10 @@ Please submit any bug reports or feature requests to the
 
 ## Contributing
 
-We greatly appreciate contributions to the PSync code base, provided that they are
+Contributions to PSync are greatly appreciated and can be made through our
-licensed under the GNU LGPL version 3 or a compatible license.
+[Gerrit code review site](https://gerrit.named-data.net/).
 If you are new to the NDN software community, please read our [Contributor's Guide](
-https://github.com/named-data/.github/blob/master/CONTRIBUTING.md) to get started.
+https://github.com/named-data/.github/blob/main/CONTRIBUTING.md) to get started.
 
 ## License
 

docs/doxygen.conf.in

@@ -437,7 +437,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = YES
+EXTRACT_STATIC         = NO
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,
@@ -1178,7 +1178,7 @@ HTML_COLORSTYLE_GAMMA  = 91
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_TIMESTAMP         = YES
+HTML_TIMESTAMP         = NO
 
 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
 # documentation will contain sections that can be hidden and shown after the

docs/index.rst

@@ -28,14 +28,24 @@ Documentation
 - :doc:`release-notes`
 - :doc:`releases`
 
+Issues
+------
+
+Please submit any bug reports or feature requests to the
+`PSync issue tracker <https://redmine.named-data.net/projects/psync/issues>`__.
+
 Contributing
 ------------
 
-We greatly appreciate contributions to the PSync code base, provided that they are
+Contributions to PSync are greatly appreciated and can be made through our
-licensed under the GNU LGPL version 3 or a compatible license (see `COPYING.md
+`Gerrit code review site <https://gerrit.named-data.net/>`__.
-<https://github.com/named-data/PSync/blob/master/COPYING.md>`__ for more information).
 If you are new to the NDN software community, please read our `Contributor's Guide
-<https://github.com/named-data/.github/blob/master/CONTRIBUTING.md>`__ to get started.
+<https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>`__ to get started.
 
-Please submit any bug reports or feature requests to the `PSync issue tracker
+License
-<https://redmine.named-data.net/projects/psync/issues>`__.
+-------
+
+PSync is free software: you can redistribute it and/or modify it under the terms of
+the GNU Lesser General Public License as published by the Free Software Foundation,
+either version 3 of the License, or (at your option) any later version. See `COPYING.md
+<https://github.com/named-data/PSync/blob/master/COPYING.md>`__ for details.

docs/install.rst

@@ -4,7 +4,7 @@ Installation Instructions
 Prerequisites
 -------------
 
--  `ndn-cxx <https://named-data.net/doc/ndn-cxx>`_ and its dependencies
+- `ndn-cxx <https://docs.named-data.net/ndn-cxx/>`__ and its dependencies
 
 Build
 -----

docs/named_data_theme/named_data_header.html

@@ -32,7 +32,7 @@ $mathjax
 
          <!--top menu-->
          <div class="nine columns" id="menu_container" >
-           <h1><a href="https://named-data.net/doc/PSync/$projectnumber/">$projectname $projectnumber documentation</a></h1>
+           <h1><a href="https://docs.named-data.net/PSync/$projectnumber/">$projectname $projectnumber documentation</a></h1>
          </div>
     </div>
 </div><!--header container end-->

wscript

@@ -197,7 +197,9 @@ def version(ctx):
         Logs.warn('%s is not writable (%s)' % (versionFile, e.strerror))
 
 def dist(ctx):
+    ctx.algo = 'tar.xz'
     version(ctx)
 
 def distcheck(ctx):
+    ctx.algo = 'tar.xz'
     version(ctx)