Skip to content

Commit 652061d

Browse files
jordanrobotjordanrobot
committed
docs: add ExternalRuleDirectory documentation
disable nuke PublishGitHubRelease
1 parent bdec808 commit 652061d

28 files changed

+892
-850
lines changed

‎CHANGELOG.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
## [1.3.0](https://github.com/InventorCode/InventorShims/releases/tag/1.3.0) (2021-09-03)
1+
## [1.3.1](https://github.com/InventorCode/InventorShims/releases/tag/1.3.1) (2021-09-03)
22

33
### Added
44
- ExternalRuleDirectories object now implements the IDisposable interface, allowing the using keyword.
5-
- Updated Nuke Build system. Now creates
5+
- ExternalRuleDirectories documentation.
6+
- Updated Nuke Build system.
67

78
### Changed
89
- Integration test project "InventorShims.tests" now uses the NUnit test framework.

‎build/Build.cs

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
using static Nuke.Common.Tools.DotNet.DotNetTasks;
2222
using static Nuke.Common.Tools.MSBuild.MSBuildTasks;
2323
using static Nuke.Common.Tools.NuGet.NuGetTasks;
24-
using Nuke.GitHub;
25-
using static Nuke.GitHub.GitHubTasks;
26-
using System.Threading.Tasks;
24+
//using Nuke.GitHub;
25+
//using static Nuke.GitHub.GitHubTasks;
26+
//using System.Threading.Tasks;
2727

2828
[CheckBuildProjectConfigurations]
2929
internal class Build : NukeBuild
@@ -123,31 +123,31 @@ internal class Build : NukeBuild
123123
});
124124
});
125125

126-
private Target PublishGitHubRelease => _ => _
127-
.DependsOn(Pack)
128-
.Requires(() => GitHubAuthenticationToken)
129-
.OnlyWhenStatic(() => GitRepository.IsOnMasterBranch() || GitRepository.IsOnReleaseBranch())
130-
.Executes<Task>(async () =>
131-
{
132-
var releaseTag = $"v{GitVersion.MajorMinorPatch}";
133-
134-
var changeLogSectionEntries = ExtractChangelogSectionNotes(ChangeLogFile);
135-
var latestChangeLog = changeLogSectionEntries
136-
.Aggregate((c, n) => c + Environment.NewLine + n);
137-
var completeChangeLog = $"## {releaseTag}" + Environment.NewLine + latestChangeLog;
138-
139-
var repositoryInfo = GetGitHubRepositoryInfo(GitRepository);
140-
var nuGetPackages = GlobFiles(OutputDirectory, "*.nupkg").NotEmpty().ToArray();
141-
142-
await PublishRelease(s => s
143-
.SetArtifactPaths(nuGetPackages)
144-
.SetCommitSha(GitVersion.Sha)
145-
.SetReleaseNotes(completeChangeLog)
146-
.SetRepositoryName(repositoryInfo.repositoryName)
147-
.SetRepositoryOwner(repositoryInfo.gitHubOwner)
148-
.SetTag(releaseTag)
149-
.SetToken(GitHubAuthenticationToken));
150-
});
126+
//private Target PublishGitHubRelease => _ => _
127+
// .DependsOn(Pack)
128+
// .Requires(() => GitHubAuthenticationToken)
129+
// .OnlyWhenStatic(() => GitRepository.IsOnMasterBranch() || GitRepository.IsOnReleaseBranch())
130+
// .Executes<Task>(async () =>
131+
// {
132+
// var releaseTag = $"v{GitVersion.MajorMinorPatch}";
133+
134+
// var changeLogSectionEntries = ExtractChangelogSectionNotes(ChangeLogFile);
135+
// var latestChangeLog = changeLogSectionEntries
136+
// .Aggregate((c, n) => c + Environment.NewLine + n);
137+
// var completeChangeLog = $"## {releaseTag}" + Environment.NewLine + latestChangeLog;
138+
139+
// var repositoryInfo = GetGitHubRepositoryInfo(GitRepository);
140+
// var nuGetPackages = GlobFiles(OutputDirectory, "*.nupkg").NotEmpty().ToArray();
141+
142+
// await PublishRelease(s => s
143+
// .SetArtifactPaths(nuGetPackages)
144+
// .SetCommitSha(GitVersion.Sha)
145+
// .SetReleaseNotes(completeChangeLog)
146+
// .SetRepositoryName(repositoryInfo.repositoryName)
147+
// .SetRepositoryOwner(repositoryInfo.gitHubOwner)
148+
// .SetTag(releaseTag)
149+
// .SetToken(GitHubAuthenticationToken));
150+
// });
151151

152152
private string DocFxFile => RootDirectory / "docfx" / "docfx.json";
153153
private string DocFxOutputFolder => RootDirectory / "doc";

‎build/_build.csproj

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1919
</PackageReference>
2020
<PackageReference Include="Nuke.Common" Version="5.3.0" />
21-
<PackageReference Include="Nuke.GitHub" Version="2.0.0" />
2221
<PackageDownload Include="docfx.console" Version="[2.56.6]" />
2322
<PackageDownload Include="GitVersion.Tool" Version="[5.5.1]" />
2423
</ItemGroup>

‎docfx/articles/changelog.md

Lines changed: 124 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,125 @@
1-
## Changelog
1+
## [1.3.1](https://github.com/InventorCode/InventorShims/releases/tag/1.3.1) (2021-09-03)
2+
3+
### Added
4+
- ExternalRuleDirectories object now implements the IDisposable interface, allowing the using keyword.
5+
- ExternalRuleDirectories documentation.
6+
- Updated Nuke Build system.
7+
8+
### Changed
9+
- Integration test project "InventorShims.tests" now uses the NUnit test framework.
10+
- Refactored some duplicate tests into TestCases.
11+
- Refactored Inventor document creation routines to TestUtilities.cs.
12+
- Nuke build updated to Nuke 5.3.0
13+
- Nuget packages for build project updated.
14+
- Nuke build targets updated/created:
15+
- Nuke Compile
16+
- Nuke Pack
17+
- Nuke Push
18+
- Nuke BuildDocumentation
19+
- Nuke PublishGitHubRelease
20+
- InventorShims.manual tests changed to InventorShims.ilogic.tests. Removed VS project associated with this.
21+
22+
### Fixed
23+
- ExternalRuleDirectories.Add was not adding entires properly.
24+
- ExternalRuleDirectories.Remove was not removing entires properly.
25+
26+
### Removed
27+
- InventorShims-vb project has been removed.
28+
- Errant NewtonSoft.Json package reference
29+
30+
## [1.2.0](https://github.com/InventorCode/InventorShims/releases/tag/1.2.0) (2021-08-15)
31+
32+
### Added
33+
- ExternalRuleDirectories object allows you to manipulate the iLogic Addin's list of External Rules Directories in a more straightforward manner.
34+
35+
### Fixed
36+
- Added conventional commits keywords to gitversion configuration.
37+
38+
39+
## [1.1.1](https://github.com/InventorCode/InventorShims/releases/tag/v1.1.1) (2021-02-11)
40+
41+
### Chore
42+
43+
* remove ILMerge nuget package
44+
45+
### Docs
46+
47+
* rebuild
48+
* remove InventorShims-vb
49+
50+
51+
## [v1.1.0](https://github.com/InventorCode/InventorShims/releases/tag/v1.1.0) (2021-02-11)
52+
53+
### Chore
54+
55+
* update nuget config, changelog, versions
56+
* add nuspec
57+
* add logo for nuget package
58+
* Removed InventorShims-vs from builds
59+
* renamed InventorShims-cs to InventorShims
60+
61+
### Docs
62+
63+
* added initial changelog
64+
* removed reference to pre-release state.
65+
* Updated API docs link in readme
66+
* Added samples to ParameterShim, added more to the class description.
67+
* Added ParameterShim and PathShim samples.
68+
69+
### Feat
70+
71+
* added git-chglog config
72+
* ParameterIsWritable string signature added
73+
* ParameterIsWritable now acts as an extension method
74+
75+
### Style
76+
77+
* remove whitespace
78+
79+
### Test
80+
81+
* Added ParameterIsWritable unit tests.
82+
83+
## [v1.0.0](https://github.com/InventorCode/InventorShims/releases/tag/v1.0.0) (2021-01-17)
84+
85+
### Build
86+
87+
* v1.0.0
88+
89+
### Docs
90+
91+
* new build
92+
* Added Conventional Commits as the commit format guideline.
93+
* added --force to docfx rebuild. Added new template reference for icons
94+
* added logo and favicon
95+
* rebuilt with manual fix for "view source" error
96+
* Added an ilogic rule sample
97+
* tentative fix for "View Source" in docfx not working.
98+
99+
### Feat
100+
101+
* AttributeShim methods are now extension methods.
102+
103+
### Fix
104+
105+
* fixed typoe in sample. Added commented out msgbox call.
106+
* GetDocumentFromObject for kDrawingDurveSegmentObject
107+
108+
### Refactor
109+
110+
* added error handling to SaveSilently() method
111+
* PathShim moved to C#
112+
* added todo for ittermittent bug in test
113+
114+
### Test
115+
116+
* Added debug statements to GetDocumentsFromSelectSet()
117+
* GetDocumentFromObject.tests updated
118+
* ApplicationShim tests now wait for Inventor processes to finish.
119+
120+
### Tests
121+
122+
* modified for newest PathShim.cs
123+
124+
## [v0.1.0](https://github.com/InventorCode/InventorShims/releases/tag/v0.1.0) (2020-12-25)
2125

3-
There is nothing here yet, but there will be!

‎docs/api/InventorShims.ApplicationShim.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h3 id="methods">Methods
118118
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_ApplicationShim_CurrentInstance.md&amp;value=---%0Auid%3A%20InventorShims.ApplicationShim.CurrentInstance%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
119119
</span>
120120
<span class="small pull-right mobile-hide">
121-
<a href="https://github.com/InventorCode/InventorShims/blob/jr/iLogicShim/src/InventorShims/ApplicationShim.cs/#L61">View Source</a>
121+
<a href="https://github.com/InventorCode/InventorShims/blob/build/update-nuke/src/InventorShims/ApplicationShim.cs/#L61">View Source</a>
122122
</span>
123123
<a id="InventorShims_ApplicationShim_CurrentInstance_" data-uid="InventorShims.ApplicationShim.CurrentInstance*"></a>
124124
<h4 id="InventorShims_ApplicationShim_CurrentInstance" data-uid="InventorShims.ApplicationShim.CurrentInstance">CurrentInstance()</h4>
@@ -154,7 +154,7 @@ <h5 id="InventorShims_ApplicationShim_CurrentInstance_remarks">Remarks</h5>
154154
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_ApplicationShim_Instance.md&amp;value=---%0Auid%3A%20InventorShims.ApplicationShim.Instance%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
155155
</span>
156156
<span class="small pull-right mobile-hide">
157-
<a href="https://github.com/InventorCode/InventorShims/blob/jr/iLogicShim/src/InventorShims/ApplicationShim.cs/#L21">View Source</a>
157+
<a href="https://github.com/InventorCode/InventorShims/blob/build/update-nuke/src/InventorShims/ApplicationShim.cs/#L21">View Source</a>
158158
</span>
159159
<a id="InventorShims_ApplicationShim_Instance_" data-uid="InventorShims.ApplicationShim.Instance*"></a>
160160
<h4 id="InventorShims_ApplicationShim_Instance" data-uid="InventorShims.ApplicationShim.Instance">Instance()</h4>
@@ -190,7 +190,7 @@ <h5 id="InventorShims_ApplicationShim_Instance_remarks">Remarks</h5>
190190
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_ApplicationShim_NewInstance_System_Boolean_.md&amp;value=---%0Auid%3A%20InventorShims.ApplicationShim.NewInstance(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
191191
</span>
192192
<span class="small pull-right mobile-hide">
193-
<a href="https://github.com/InventorCode/InventorShims/blob/jr/iLogicShim/src/InventorShims/ApplicationShim.cs/#L84">View Source</a>
193+
<a href="https://github.com/InventorCode/InventorShims/blob/build/update-nuke/src/InventorShims/ApplicationShim.cs/#L84">View Source</a>
194194
</span>
195195
<a id="InventorShims_ApplicationShim_NewInstance_" data-uid="InventorShims.ApplicationShim.NewInstance*"></a>
196196
<h4 id="InventorShims_ApplicationShim_NewInstance_System_Boolean_" data-uid="InventorShims.ApplicationShim.NewInstance(System.Boolean)">NewInstance(Boolean)</h4>
@@ -249,7 +249,7 @@ <h5 id="InventorShims_ApplicationShim_NewInstance_System_Boolean__remarks">Remar
249249
<a href="https://github.com/InventorCode/InventorShims/new/master/docs-ref-overwrite/new?filename=InventorShims_ApplicationShim.md&amp;value=---%0Auid%3A%20InventorShims.ApplicationShim%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
250250
</li>
251251
<li>
252-
<a href="https://github.com/InventorCode/InventorShims/blob/jr/iLogicShim/src/InventorShims/ApplicationShim.cs/#L11" class="contribution-link">View Source</a>
252+
<a href="https://github.com/InventorCode/InventorShims/blob/build/update-nuke/src/InventorShims/ApplicationShim.cs/#L11" class="contribution-link">View Source</a>
253253
</li>
254254
</ul>
255255
</div>

0 commit comments

Comments
 (0)