Skip to content

Commit 2f7327b

Browse files
andrew-plattandrew-platt
committed
v4.0.1 changelog/release notes/ version update
1 parent 4eaa7f2 commit 2f7327b

File tree

4 files changed

+176
-1
lines changed

4 files changed

+176
-1
lines changed

‎docs/changelogs/ReleaseProcess.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# OpenFAST release process
2+
3+
## Prep
4+
### pull request
5+
1. Create release changelog.md
6+
2. Post PR with contents of the changelog/release notes
7+
3. Get reviews and address all issues
8+
9+
### PR branch updates
10+
1. checkout branch to merge in and verify builds on VS if any changes for VS or new files added
11+
2. Update the documentation version in docs/conf.py
12+
3. Update the versions in docs/source/user/api_change.rst
13+
4. Verify readthedocs builds correctly
14+
5. Update `openfast_io/pyproject.toml`
15+
16+
****
17+
18+
## Posting the release
19+
### r-test
20+
1. Merge and add annotated tag
21+
2. Update pointer on main OF repository (not always necessary)
22+
23+
### Main repository
24+
1. Merge PR
25+
2. Create release with new tag
26+
* Copy `Changelog` section down from the changlog.md file to release notes
27+
* add short intro section at top with 2 sentence synopsis (see prior release for this)
28+
* copy `Precompiled Windows Binaries` section from prior release, and update as needed into the release notes
29+
* check the `create discussion` box
30+
* Post
31+
3. delete `rc-` branch if merging from one
32+
33+
### Windows executables build and upload
34+
After posting and tagging release
35+
1. Pull main and tags
36+
* `git fetch --tags OpenFAST`
37+
* `git fetch OpenFAST main:main`
38+
* `git checkout main`
39+
2. Delete `vs-build` and checkout again
40+
* `rm -rf vs-build`
41+
* `git checkout vs-build`
42+
3. Set a couple of VS files to not track changes on files that VS wants to update Windows related stuff in
43+
```
44+
git update-index --assume-unchanged vs-build/MAPlib/MAP_dll.vcxproj vs-uild/Registry/FAST_Registry.vcxproj
45+
```
46+
47+
4. Compile executables for Windows builds
48+
* Run one of the executables and check the version info. Muck about with VS if there is an issue.
49+
* Also run `dumpbin.exe /dependents <exe>.exe` to check static linking
50+
* NOTE: build the simulink last -- it messes up some things otherwise
51+
- [ ] AeroDyn_Driver_x64.exe
52+
- [ ] AeroDyn_Driver_x64_OpenMP.exe
53+
- [ ] AeroDyn_Inflow_C_Binding_x64.dll
54+
- [ ] AeroDyn_Inflow_C_Binding_x64_OpenMP.dll
55+
- [ ] BeamDyn_Driver_x64.exe
56+
- [ ] DISCON.dll (x64)
57+
- [ ] DISCON_ITIBarge.dll (x64)
58+
- [ ] DISCON_OC3Hywind.dll (x64)
59+
- [ ] DISCON_SC.dll (x64)
60+
- [ ] FAST.Farm_x64.exe
61+
- [ ] FAST.Farm_x64_OMP.exe
62+
- [ ] FAST_SFunc.mexw64 -- build from MATLAB
63+
- [ ] HydroDynDriver_x64.exe
64+
- [ ] HydroDyn_C_Binding_x64.dll
65+
- [ ] IfW_C_Binding_x64.dll
66+
- [ ] InflowWind_Driver_x64.exe
67+
- [ ] InflowWind_Driver_x64_OpenMP.exe
68+
- [ ] MoorDyn_Driver_x64.exe
69+
- [ ] MoorDyn_C_Binding_x64.dll
70+
- [ ] OpenFAST-Simulink_x64.dll -- change `additional dependencies` in the `OpenFAST-Simulink` project in `FAST` to point to correct install of MATLAB
71+
- [ ] openfast_x64.exe
72+
- [ ] SubDyn_x64.exe
73+
- [ ] Turbsim_x64.exe
74+
75+
5. Upload all filesUnset the no tracking of files
76+
```
77+
git ls-files -v | grep "^[a-z]"
78+
git update-index --no-assume-unchanged <files-from-cmd-above>
79+
```
80+
81+

‎docs/changelogs/v4.0.1.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
**Feature or improvement description**
2+
Pull request to merge `rc-4.0.1` into `main` and create a tagged release for v4.0.1
3+
4+
See the milestone and project pages for additional information
5+
6+
https://github.com/OpenFAST/openfast/milestone/16
7+
8+
Test results, if applicable
9+
See GitHub Actions
10+
11+
### Release checklist:
12+
- [ ] Update the documentation version in docs/conf.py
13+
- [ ] Update the versions in docs/source/user/api\_change.rst
14+
- [ ] Verify readthedocs builds correctly
15+
- [ ] Create a tag in OpenFAST
16+
- [ ] Create a merge commit in r-test and add a corresponding annotated tag
17+
- [ ] Compile executables for Windows builds
18+
- [ ] `AeroDyn_Driver_x64.exe`
19+
- [ ] `AeroDyn_Driver_x64_OpenMP.exe`
20+
- [ ] `AeroDyn_Inflow_C_Binding_x64.dll`
21+
- [ ] `AeroDyn_Inflow_C_Binding_x64_OpenMP.dll`
22+
- [ ] `BeamDyn_Driver_x64.exe`
23+
- [ ] `DISCON.dll (x64)`
24+
- [ ] `DISCON_ITIBarge.dll (x64)`
25+
- [ ] `DISCON_OC3Hywind.dll (x64)`
26+
- [ ] `DISCON_SC.dll (x64)`
27+
- [ ] `FAST.Farm_x64.exe`
28+
- [ ] `FAST.Farm_x64_OMP.exe`
29+
- [ ] `FAST_SFunc.mexw64`
30+
- [ ] `HydroDynDriver_x64.exe`
31+
- [ ] `HydroDyn_C_Binding_x64.dll`
32+
- [ ] `IfW_C_Binding_x64.dll`
33+
- [ ] `InflowWind_Driver_x64.exe`
34+
- [ ] `InflowWind_Driver_x64_OpenMP.exe`
35+
- [ ] `MoorDyn_Driver_x64.exe`
36+
- [ ] `MoorDyn_C_Binding_x64.dll`
37+
- [ ] `OpenFAST-Simulink_x64.dll`
38+
- [ ] `openfast_x64.exe`
39+
- [ ] `SubDyn_x64.exe`
40+
- [ ] `Turbsim_x64.exe`
41+
42+
# Changelog
43+
44+
## Overview
45+
46+
This release includes multiple small bug-fixes including compilation issues with Flang and Intel (IFX), improved diagnostics for the AeroDyn\_Inflow\_c-binding interace, user specified external loads for MoorDyn, `Wind_IO` updates, a fix for a stack overflow with FAST.Farm built with Visual Studio on Windows, and other minor bugfixes.
47+
48+
49+
50+
## General
51+
52+
### Wind_IO
53+
54+
#2603 updates to handle writing OpenFAST models from weis and wind_io (mayankchetan)
55+
56+
57+
### Build systems
58+
59+
#2607 Windows VS build -- stack overflow with FAST.Farm (andrew-platt)
60+
61+
#2619 ROCM Flang doesn't compile NWTC_IO.f90 (andrew-platt)
62+
63+
#2621 Bugfix: missing include path in `create_FAST_SFunc.m` (andrew-platt)
64+
65+
66+
## Module changes
67+
68+
### AeroDyn
69+
70+
#2609 AD bugfix: aerodyn driver non-OLAF combined cases don't update wind (andrew-platt)
71+
72+
#2615 Improve diagnostics for ADI_c interface coupling (andrew-platt)
73+
74+
75+
### MoorDyn
76+
77+
#2597 MD: User-specified external forces and translational damping for MoorDyn point, rod, and body objects (luwang00)
78+
79+
80+
## Input file changes
81+
82+
No input file changes are required from 4.0.0. MoorDyn can contain an option section for `External Loads`.
83+
84+
Full list of changes: https://openfast.readthedocs.io/en/main/source/user/api_change.html
85+
86+
Full input file sets: https://github.com/OpenFAST/r-test/tree/v4.0.1 (example input files from the regression testing)
87+

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
138138
# The short X.Y version.
139139
version = u'4.0'
140140
# The full version, including alpha/beta/rc tags.
141-
release = u'v4.0.0'
141+
release = u'v4.0.1'
142142

143143
# The language for content autogenerated by Sphinx. Refer to documentation
144144
# for a list of supported languages.

‎docs/source/user/api_change.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ Thus, be sure to implement each in order so that subsequent line numbers are cor
1111

1212

1313

14+
OpenFAST v4.0.0 to OpenFAST v4.0.1
15+
----------------------------------
16+
17+
No input file changes are required. MoorDyn can contain an option section for
18+
`External Loads` (see the MoorDyn documentation for details).
19+
20+
1421
OpenFAST v3.5.5 to OpenFAST 4.0.0
1522
---------------------------------
1623

0 commit comments

Comments
 (0)