Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparation for release 0.3.0 #27

Draft
wants to merge 19 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Changelog

## DLA-Future-Fortran 0.3.0

### Added

* Documentation with [Ford] [PR #8]
* Calculation of partial eigenspectrum [PR #26 | PR #28]
* `libs` property to Spack package [PR #25]
* `pkgconfig` as build dependency to Spack package [PR #23]
RMeli marked this conversation as resolved.
Show resolved Hide resolved

## DLA-Future-Fortran 0.2.0

### Added
Expand All @@ -20,3 +29,4 @@ First release of [DLA-Future-Fortran], a Fortran interface for [DLA-Future].

[DLA-Future]: https://github.com/eth-cscs/DLA-Future
[DLA-Future-Fortran]: https://github.com/eth-cscs/DLA-Future-Fortran
[Ford]: https://forddocs.readthedocs.io/en/stable/
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
cff-version: 1.2.0
title: DLA-Future-Fortran 0.2.0
title: DLA-Future-Fortran 0.3.0
repository-code: 'https://github.com/eth-cscs/DLA-Future-Fortran'
abstract: Fortran interface for DLA-Future (Distributed Linear Algebra from the Future)
version: 0.2.0
date-released: '2024-07-05'
version: 0.3.0
date-released: '2024-12-17'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update date to release day.

type: software
authors:
- given-names: Rocco
Expand Down
4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ cmake_minimum_required(VERSION 3.22)

# NOTE: CXX needed with DLA-Future
# NOTE: C needed with HDF5 (dla-future +hdf5)
project(DLAFFortran VERSION 0.2.0 LANGUAGES Fortran C CXX)
project(DLAFFortran VERSION 0.3.0 LANGUAGES Fortran C CXX)

include(CMakeDependentOption)
include(GNUInstallDirs)
Expand All @@ -30,7 +30,7 @@ if(NOT CMAKE_Fortran_MODULE_DIRECTORY)
set(CMAKE_Fortran_MODULE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/fortran_mods)
endif ()

find_package(DLAF 0.6.0 REQUIRED)
find_package(DLAF 0.7.0 REQUIRED)
RMeli marked this conversation as resolved.
Show resolved Hide resolved

add_subdirectory(src)

Expand Down
13 changes: 10 additions & 3 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,23 @@

## How to generate the documentation

Install Python dependencies:

```bash
python -m pip install -r requirements.txt
```

The Fortran code is documented using [FORD] (FORtran Documenter), an automatic documentation generator for modern Fortran projects.

```bash
python -m ford --output_dir documentation DLA-Future-Fortran.md
python -m ford DLA-Future-Fortran.md
```

By default, the documentation is generated in the `doc-ford` directory.

## Documentation on GitHub

The documentation is hosted on [GitHub Pages]. Documentation is generated automatically by the [GitHub Action] `.github/workflows/docs.yaml`
for each version (`v*` tag) and for the `main` branch.
The documentation is hosted on [GitHub Pages]. Documentation is generated automatically by the [GitHub Action] `.github/workflows/docs.yaml` for each version (`v*` tag) and for the `main` branch.

The documentation is pushed by the [GitHub Action] to the `docs-ghpages` branch. This branch was manually created as an orphan branch with

Expand Down
2 changes: 2 additions & 0 deletions RELEASE_PROCEDURE.md
RMeli marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should also be changed according to eth-cscs/DLA-Future#1250

Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,6 @@ DLA-Future-Fortran follows [Semantic Versioning](https://semver.org).
with local repository. Exclude blocks delimited by `# !!!` comments. These are only intended for the
internal Spack package.

1. Add release documentation to `DOCUMENTATION.md`.

1. Delete your `GITHUB_TOKEN` if created only for the release.
2 changes: 1 addition & 1 deletion ci/ci-common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ stages:
reports:
dotenv: build.env
variables:
SPACK_SHA: develop-2024-12-15
SPACK_SHA: 6005813518e41a890e9b7c93bf7190c4181d3c5e
SPACK_BUILDCACHE: develop-2024-12-15
SPACK_DLAF_FORTRAN_REPO: ./spack
DOCKER_BUILD_ARGS: '[
Expand Down
2 changes: 1 addition & 1 deletion ci/docker/common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ packages:
- '~libxml2'
dla-future:
require:
- '@master'
- '@git.version_0.7'
RMeli marked this conversation as resolved.
Show resolved Hide resolved
git:
# Force git as non-buildable to allow deprecated versions in environments
# https://github.com/spack/spack/pull/30040
Expand Down
2 changes: 1 addition & 1 deletion spack/packages/dla-future-fortran/package.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class DlaFutureFortran(CMakePackage):

depends_on("[email protected]:0.5 +scalapack", when="@0.1.0")
depends_on("[email protected]: +scalapack", when="@0.2.0:")
depends_on("dla-future@master: +scalapack", when="@main")
depends_on("dla-future@0.7.0: +scalapack", when="@0.3:") # TODO: Change to 0.7.3
RMeli marked this conversation as resolved.
Show resolved Hide resolved
depends_on("dla-future +shared", when="+shared")

depends_on("mpi", when="+test")
Expand Down
Loading