Skip to content

The Unified and Autonomous Development Platform

feat: Use .wikiignore to exclude files for wiki

Robin Shen3964454eabbf
diff --git a/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiSetting.java b/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiSetting.java
index aaeeae3634..655cc4171b 100644
--- a/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiSetting.java
+++ b/server-core/src/main/java/io/onedev/server/model/support/wiki/WikiSetting.java
@@ -15,7 +15,8 @@ public class WikiSetting implements Serializable {
@Editable(name="Wiki Folder", placeholder="Inherit from parent", rootPlaceholder="Use folder 'wiki'", description="""
Specify the repository folder to store wiki pages. Leave empty to inherit from parent.
If you do not want to store wiki pages in the project repository, the specified folder
- can be a Git submodule""")
+ can be a Git submodule. To exclude files from the wiki Pages panel, add a <code>.wikiignore</code>
+ file in the wiki root folder with Git ignore patterns relative to that folder""")
@Valid
public WikiFolder getFolder() {
return folder;
diff --git a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.java b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.java
index 64db72f704..d3cd6b351a 100644
--- a/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.java
+++ b/server-core/src/main/java/io/onedev/server/web/page/project/wiki/ProjectWikiPage.java
@@ -2,7 +2,10 @@ package io.onedev.server.web.page.project.wiki;
import static io.onedev.server.web.translation.Translation._T;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
import java.io.Serializable;
+import java.io.UncheckedIOException;
import java.nio.charset.StandardCharsets;
import java.text.MessageFormat;
import java.util.ArrayList;
@@ -46,6 +49,7 @@ import org.apache.wicket.model.IModel;
import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.validation.ValidationError;
+import org.eclipse.jgit.ignore.IgnoreNode;
import org.eclipse.jgit.lib.FileMode;
import org.jspecify.annotations.Nullable;
import org.eclipse.jgit.lib.ObjectId;
@@ -306,11 +310,7 @@ public class ProjectWikiPage extends ProjectPage {
}).setEscapeModelStrings(false).setVisible(sidebar == null).setOutputMarkupPlaceholderTag(true));
navigation.add(newSidebarEdit());
navigation.add(newUseDefault(sidebar));
- List<String> pages = new ArrayList<>();
- if (commitId != null)
- collectPages(folder, pages);
- Collections.sort(pages);
- navigation.add(new ListView<String>("pages", pages) {
+ navigation.add(new ListView<String>("pages", getPages()) {
@Override
protected void populateItem(ListItem<String> item) {
String name = item.getModelObject();
@@ -854,15 +854,37 @@ public class ProjectWikiPage extends ProjectPage {
return blob.getText().getContent();
}
- private void collectPages(@Nullable String directory, List<String> pages) {
+ private List<String> getPages() {
+ List<String> pages = new ArrayList<>();
+ if (commitId != null) {
+ var ignore = new IgnoreNode();
+ String ignorePath = (folder != null ? folder + "/" : "") + ".wikiignore";
+ var blob = getWikiProject().getBlob(new BlobIdent(commitId.name(), ignorePath, FileMode.REGULAR_FILE.getBits()), false);
+ if (blob != null && blob.getIdent().isFile() && blob.getLfsPointer() == null) {
+ try (var input = new ByteArrayInputStream(blob.getBytes())) {
+ ignore.parse(input);
+ } catch (IOException e) {
+ throw new UncheckedIOException(e);
+ }
+ }
+ collectPages(folder, pages, ignore);
+ }
+ Collections.sort(pages);
+ return pages;
+ }
+
+ private void collectPages(@Nullable String directory, List<String> pages, IgnoreNode ignore) {
var ident = directory != null ? gitService.getBlobIdent(getWikiProject(), commitId, directory)
: new BlobIdent(commitId.name(), null, FileMode.TREE.getBits());
if (ident != null && ident.isTree()) {
for (var child : gitService.getChildren(getWikiProject(), commitId, directory, BlobIdentFilter.ALL, false)) {
+ String relativePath = child.path.substring(folder != null ? folder.length() + 1 : 0);
+ if (ignore.isIgnored(relativePath, child.isTree()) == IgnoreNode.MatchResult.IGNORED)
+ continue;
if (child.isTree()) {
- collectPages(child.path, pages);
+ collectPages(child.path, pages, ignore);
} else if (child.isFile() && child.path.endsWith(".md")) {
- String name = child.path.substring(folder != null ? folder.length() + 1 : 0, child.path.length() - 3);
+ String name = relativePath.substring(0, relativePath.length() - 3);
if (!name.equals("_Sidebar"))
pages.add(name);
}
@@ -943,10 +965,7 @@ public class ProjectWikiPage extends ProjectPage {
revision = branchName;
AjaxRequestTarget target = RequestCycle.get().find(AjaxRequestTarget.class).orElse(null);
selectPage(target, selectedPage);
- List<String> pages = new ArrayList<>();
- collectPages(folder, pages);
- Collections.sort(pages);
- ((ListView<String>) navigation.get("pages")).setList(pages);
+ ((ListView<String>) navigation.get("pages")).setList(getPages());
target.add(get("wiki"));
String url = urlFor(ProjectWikiPage.class, paramsOf(getProject(), revision, page)).toString();
pushState(target, JavaScriptEscape.escapeJavaScript(url), page);
diff --git a/server-core/src/test/java/io/onedev/server/web/page/project/wiki/ProjectWikiPageTest.java b/server-core/src/test/java/io/onedev/server/web/page/project/wiki/ProjectWikiPageTest.java
index 4c56ad6823..f4dafbc8f2 100644
--- a/server-core/src/test/java/io/onedev/server/web/page/project/wiki/ProjectWikiPageTest.java
+++ b/server-core/src/test/java/io/onedev/server/web/page/project/wiki/ProjectWikiPageTest.java
@@ -5,6 +5,7 @@ import static org.mockito.ArgumentMatchers.*;
import static org.mockito.Mockito.*;
import java.nio.charset.StandardCharsets;
+import java.util.List;
import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.request.mapper.parameter.PageParameters;
@@ -18,6 +19,7 @@ import org.jsoup.Jsoup;
import io.onedev.server.OneDev;
import io.onedev.server.git.Blob;
import io.onedev.server.git.BlobIdent;
+import io.onedev.server.git.BlobIdentFilter;
import io.onedev.server.git.service.GitService;
import io.onedev.server.markdown.MarkdownService;
import io.onedev.server.model.Project;
@@ -31,6 +33,53 @@ import io.onedev.server.web.resource.RawBlobResourceReference;
public class ProjectWikiPageTest {
+ @Test
+ public void wikiIgnoreFiltersPagesRelativeToWikiRoot() throws Exception {
+ for (String folder : new String[] {null, "docs/wiki"}) {
+ var project = mock(Project.class);
+ var git = mock(GitService.class);
+ var commit = ObjectId.fromString("1111111111111111111111111111111111111111");
+ var page = mock(ProjectWikiPage.class, CALLS_REAL_METHODS);
+ doReturn(project).when(page).getProject();
+ set(page, "gitService", git);
+ set(page, "folder", folder);
+ set(page, "commitId", commit);
+ String prefix = folder != null ? folder + "/" : "";
+ when(git.getBlobIdent(eq(project), eq(commit), anyString())).thenAnswer(it ->
+ new BlobIdent(commit.name(), it.getArgument(2), FileMode.TREE.getBits()));
+ when(git.getChildren(project, commit, folder, BlobIdentFilter.ALL, false)).thenReturn(List.of(
+ wikiEntry(commit, prefix + "Home.md", false),
+ wikiEntry(commit, prefix + "AGENTS.md", false),
+ wikiEntry(commit, prefix + "Root-only.md", false),
+ wikiEntry(commit, prefix + "_Sidebar.md", false),
+ wikiEntry(commit, prefix + "guide", true),
+ wikiEntry(commit, prefix + "private", true)));
+ when(git.getChildren(project, commit, prefix + "guide", BlobIdentFilter.ALL, false)).thenReturn(List.of(
+ wikiEntry(commit, prefix + "guide/AGENTS.md", false),
+ wikiEntry(commit, prefix + "guide/Root-only.md", false),
+ wikiEntry(commit, prefix + "guide/Draft-one.md", false),
+ wikiEntry(commit, prefix + "guide/Draft-keep.md", false)));
+ when(git.getChildren(project, commit, prefix + "private", BlobIdentFilter.ALL, false)).thenReturn(List.of(
+ wikiEntry(commit, prefix + "private/keep.md", false)));
+ var ignoreIdent = wikiEntry(commit, prefix + ".wikiignore", false);
+ byte[] rules = ("# Agent instructions\n\nAGENTS.md\n/Root-only.md\n"
+ + "**/Draft-*.md\n!guide/Draft-keep.md\nprivate/\n!private/keep.md\n")
+ .getBytes(StandardCharsets.UTF_8);
+ when(project.getBlob(ignoreIdent, false)).thenReturn(new Blob(ignoreIdent, commit, rules, rules.length));
+ assertEquals(List.of("Home", "guide/Draft-keep", "guide/Root-only"), invoke(page, "getPages"));
+ verify(git, never()).getChildren(project, commit, prefix + "private", BlobIdentFilter.ALL, false);
+
+ // A revision without .wikiignore keeps the existing page listing behavior.
+ when(project.getBlob(ignoreIdent, false)).thenReturn(null);
+ assertEquals(List.of("AGENTS", "Home", "Root-only", "guide/AGENTS", "guide/Draft-keep",
+ "guide/Draft-one", "guide/Root-only", "private/keep"), invoke(page, "getPages"));
+ }
+ }
+
+ private static BlobIdent wikiEntry(ObjectId commit, String path, boolean directory) {
+ return new BlobIdent(commit.name(), path, (directory ? FileMode.TREE : FileMode.REGULAR_FILE).getBits());
+ }
+
@Test
public void sidebarLinksStayAtWikiRootWhenViewingNestedPages() throws Exception {
var tester = new WicketTester();
@@ -59,6 +108,7 @@ public class ProjectWikiPageTest {
requestCycle.when(RequestCycle::get).thenReturn(cycle);
var page = mock(ProjectWikiPage.class, CALLS_REAL_METHODS);
doReturn(project).when(page).getProject();
+ set(page, "markdownService", markdown);
set(page, "revision", "main");
for (String folder : new String[] {"docs/wiki", null}) {
set(page, "folder", folder);
@@ -124,6 +174,9 @@ public class ProjectWikiPageTest {
security.when(() -> SecurityUtils.canReadCode(target)).thenReturn(scenario.equals("allowed"));
var page = mock(ProjectWikiPage.class, CALLS_REAL_METHODS);
doReturn(owner).when(page).getProject();
+ set(page, "gitService", git);
+ set(page, "settingService", settings);
+ set(page, "projectService", projects);
set(page, "folder", "wiki");
set(page, "commitId", ownerCommit);
invoke(page, "resolveWikiProject");
@@ -133,6 +186,9 @@ public class ProjectWikiPageTest {
assertNull(get(page, "wikiWarning"));
verify(target).getBlob(argThat(it -> targetCommit.name().equals(it.revision)
&& "Home.md".equals(it.path)), eq(false));
+ invoke(page, "getPages");
+ verify(target).getBlob(argThat(it -> targetCommit.name().equals(it.revision)
+ && ".wikiignore".equals(it.path)), eq(false));
} else {
assertNotNull(get(page, "wikiWarning"));
verifyNoInteractions(target);
@@ -142,9 +198,7 @@ public class ProjectWikiPageTest {
}
private static void set(ProjectWikiPage page, String name, Object value) throws Exception {
- var field = ProjectWikiPage.class.getDeclaredField(name);
- field.setAccessible(true);
- field.set(page, value);
+ org.apache.commons.lang3.reflect.FieldUtils.writeField(page, name, value, true);
}
private static Object get(ProjectWikiPage page, String name) throws Exception {