Project

General

Profile

Feature #15342

Add option to our build system for caching the wiki

Added by anonym over 1 year ago. Updated over 1 year ago.

Status:
In Progress
Priority:
Normal
Assignee:
Category:
Build system
Target version:
-
Start date:
02/22/2018
Due date:
% Done:

50%

Feature Branch:
feature/15342-cache-wiki
Type of work:
Code
Blueprint:
Starter:
Affected tool:

Related issues

Related to Tails - Feature #15864: Make onboarding of new developers easier In Progress 08/30/2018

Associated revisions

Revision 5d07d53a (diff)
Added by anonym over 1 year ago

Build system: add opt-in caching of the wiki.

This commit is dedicated to segfault! ;)

Will-fix: #15342

History

#1 Updated by anonym over 1 year ago

  • Status changed from Confirmed to In Progress
  • Assignee changed from anonym to bertagaz
  • % Done changed from 0 to 50
  • QA Check set to Ready for QA
  • Feature Branch set to feature/15342-cache-wiki

5d07d53a0a70a51bfb43d9fa7f317855362a0706 is dedicated to you, segfault! ;)

bertagaz, please review'n'merge into stable! I took some effort to confine the code so it should only fire when really wanted, to keep you Jenkins ops calm. :)

#2 Updated by bertagaz over 1 year ago

  • Target version changed from Tails_3.6 to Tails_3.7

#3 Updated by intrigeri over 1 year ago

  • Assignee changed from bertagaz to intrigeri

(Switching to the new RM/FT task split.)

#4 Updated by intrigeri over 1 year ago

  • Assignee changed from intrigeri to anonym
  • QA Check changed from Ready for QA to Dev Needed

I'm not convinced that "caching" the wiki directory makes sense: do I understand correctly that the source of the last successfully built website will be re-used, thus ignoring any change made to the website in the branch being built? I see the point of caching (saving build time) but building something different from the source that one is building from feels very wrong to me. What's the expected benefit of doing that as opposed to only caching the website build artifacts?

This is weird:

+            mkdir -p "${target}" 
+            rm -rf "${target}" 

Maybe you want something like mkdir -p $(dirname $target)? Or I misunderstand the intent?

Also, I'd rather not introduce new instances of the "wiki" nomenclature, that we're been slowly moving from for years in favour of "website": please s/wiki/website/.

Finally, is there any compelling reason to target stable? I'm not opposed to it in principle (I see that the code should be a no-op as long as the cachewiki option is not set) but I thought this was in great part meant for segfault, who's mostly working on branches based on devel anyway, so perhaps the (small) risk is not worth it.

#5 Updated by intrigeri over 1 year ago

  • Target version deleted (Tails_3.7)

#6 Updated by intrigeri 5 months ago

  • Related to Feature #15864: Make onboarding of new developers easier added

Also available in: Atom PDF